1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes
13 Backward compatibility

Purpose

This method is used to obtain events by id

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-event-manager/get-events-list/get-events-by-id	Посилання на Apiary або Swagger
Resource	/api/events/{{id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope	event:read	Scope для доступу
Components	Event manager	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	API paragraph not found	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	a89f6a26-4221-4597-a1d2-542d5e40b565

Request structure

API paragraph not found

Authorize

API paragraph not found

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

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"
    }
  ]
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response

Backward compatibility

API paragraph not found

E-Health

Get events by ID

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes

Backward compatibility