Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/device-dispenses/get-device-dispenses-by-search-params/get-device-dispenses-by-search-params	Посилання на Apiary або Swagger
Resource	/api/device_dispenses	Посилання на ресурс, наприклад: /api/persons/create
Scope	`device_dispense:read`	Scope для доступу
Components	Devices	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices		Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Service returns specified Device dispenses related to the legal entity from token:

...

Filter	Type	Description	Example
based_on	String		`9075e0e2-6b57-47fd-aff7-324806efa7e6`
performer_legal_entity	String		`9075e0e2-6b57-47fd-aff7-324806efa7e6`
location	String		`9075e0e2-6b57-47fd-aff7-324806efa7e6`
performer	String		`9075e0e2-6b57-47fd-aff7-324806efa7e6`
status	String		`completed`
when_handed_over_from	String	date of dispense	`2023-08-02T10:45:16.000Z`
when_handed_over_to	String	date of dispense	`2023-08-02T10:45:16.000Z`
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 300. Default: 50	`50`

Request structure

API paragraph not found

Verify the validity of access token
- Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
- in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'device_dispense:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: device_dispense:read') in case of invalid scope(s)

...

Extract client_id (performer_legal_entity) from token.
- Return empty array in case employee has no access to medication dispense.

...

See on Apiary

...