Get text summary for Session
GET /api/v1/session/{sessionId}/summary
Description
Get a summary of the session.
Request Parameters (path)
| Name | Description | Required | Type | Default Value |
|---|---|---|---|---|
sessionId | The identifier of the session | Yes | uuid | |
language | The language used for presentation | No | Language | Clinic default language |
Language
| String value | Description |
|---|---|
en | English |
fi | Finnish |
no | Norwegian |
sv | Swedish |
Response
HTTP Status Codes
| Code | Description |
|---|---|
| 200 | Success, returns a Summary |
| 401 | Unauthorized, missing X-Red-Robin-API-Key header |
| 403 | Forbidden, invalid X-Red-Robin-API-Key header |
| 404 | Not found, invalid configuration |
Summary
| Name | Description | Type | Example |
|---|---|---|---|
data | A text version summary of the session | string | \"Reason for contact:\\nFever\\n\\nCurrent... |
Example Usage
- Javascript
GET /api/v1/session/{sessionId}/summary
const headers = new Headers();
headers.append('X-Red-Robin-API-Key', 'API_KEY');
headers.append('Content-Type', 'application/json');
const requestOptions = {
method: 'GET',
headers: headers,
};
fetch('https://se.visibatriage.com/api/v1/session/{sessionId}/summary', requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));
Example Success Response
{
"data": "\"Reason for contact:\\nFever\\n\\nCurrent information:\\nfever\\n\\nConfirmed symptoms:\\nFever onset: Less than 1 hour ago\\nFever variation: Constant\\nFever trend: Increased greatly\\nTemperature: 36.5\\n\\n\""
}