Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/deactivate-legal-entity	Посилання на Apiary або Swagger
Resource	/api/legal_entities/{{id}}/actions/deactivate	Посилання на ресурс, наприклад: /api/persons/create
Scope	legal_entity:deactivate	Scope для доступу
Components	Legal Entities	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Private (NHS)	Потрібно зазначити тип методу за ступенем доступності

Logic

...

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

...

Verify the validity of access token
Check user scope legal_entity:deactivate in order to perform this action
1. In case error - return 401 error

Наприклад:

Content-Type:application/json

...

Validate transition according to Available transitions. Deactivation of an legal_entity is possible if parameters have the following values: is_active = true & status = ACTIVE or SUSPENDED.
1. In case error return Error 409 message "Invalid transition".

...

Change legal_entity status to CLOSED

For PHARMACY legal entity type only (according to link).

For related divisions deactivate linked active medical program provision entities:

set is_active = false
set deactivate_reason = AUTO_LEGAL_ENTITY_DEACTIVATION (according to PROVISION_DEACTIVATE_REASON dictionary)
set updated_at, updated by

Example:

...

Page Properties

id	API_HTTP status codes

HTTP status code	Message	What caused the error
200	Response
401		Check user Invalid scope failed
409	Invalid transition