Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/divisions/get-divisions	Посилання на Apiary або Swagger
Resource	/api/divisions	Посилання на ресурс, наприклад: /api/persons/create
Scope	division:read	Scope для доступу
Components	Divisions	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Filters

All search params are optional. Search with a few params executes according to the logical AND rule.

...

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}

Request data validation

...

Extract client_id from token.
Check client scopes in order to perform this action (scope = 'division:read')
- in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: division:read”
Check legal entity status (status = ACTIVE, SUSPENDED)
- In case of error - return 422 “Legal entity is not active”

Example:

...

Page Properties

id	API_HTTP status codes