You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 9
Next »
Properties of a REST API method document
Purpose
This method is used to obtain list of events with filters
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | | | | | |
| 2 | | | | | |
Request structure
See on API-specification
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
See on API-specification
Example
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": [
{
"id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"event_type": "StatusChangeEvent",
"entity_type": "MedicationDispense",
"entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"properties": {
"status": {
"new_value": "COMPLETED"
},
"employee_id": {
"new_value": "e1453f4c-1077-4e85-8c98-c13ffca0063e"
}
},
"event_time": "2017-04-20T19:14:13Z",
"changed_by": "df9f70ee-4b12-4740-b0f5-bb5aea116863"
}
],
"paging": {
"page_number": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 23
}
}
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | Response | | |
| 3 | Специфічні |
| 4 | | | | | |
Post-processing processes
N/A
Technical modules where the method is used