Table of Contents

Page Properties

id	API_Specification

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

Filters

Filter	Type	Description	Example
classification_type	String	Classification type. Dictionary `device_definition_classification_type`	`30221`
model_number	String	Model number for the device	`H00P53`
name	String	Device name	`Some name`
name_type	Enum	Device name type. Dictionary `device_name_type`	`registered`
medical_program_id	String	medical program id	`d290f1ee-6c54-4b01-90e6-d701748f0851`
is_active	Boolean	device definition status	`true`
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`

...

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_definitions:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: device_definitionsdefinitions:read') in case of invalid scope(s)

...

Versions Compared