Table of Contents

Page Properties

id	API_Specification

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

Logic

Update Device dispense data in device_dispenses (MongoDB):
1. set status = ‘stopped’
2. updated_by = user_id
3. updated_at = now()
Send StatusChangeEvent to Event Manager

...

Verify the validity of access token
- in case of error - 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:stop')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: device_dispense:stop”) in case of invalid scope(s)

Headers

API paragraph not foundContent-Type:application/json

...

API paragraph not found

See on Apiary

...