REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
This method should be used for the deactivation of the division
Logic
Only authenticated and authorized user can use this service
Only ACTIVE division can be deactivated
Legal entity can deactivate only its own divisions
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | id |
| String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
2 |
Request structure
See on API-specification
Headers
Key | Value | Mandatory | Description | Example | |
---|---|---|---|---|---|
1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
2 | Authorization | Bearer {{access_token}} | M | Перевірка користувача | Authorization:Bearer {{access_token}} |
3 | API-key | {{mis_client_secret}} | API-key:{{mis_client_secret}} |
Request data validation
Authorize
Verify the validity of access token
Return 401 in case validation failsCheck scopes in order to perform this action (scope = 'division:deactivate')
Return 403 in case invalid scope(s)
Validate division
Check that division with such ID exists in the system (is_active = true)
In case of error - return 404
Check that division belongs to the same legal entity as the user
In case of error - return 403
Validate healthcare service
Check that there are no active healthcare services related to this division
Search for healthcare services with this division in status ACTIVE
If search result contains any records - return 409 error (Division cannot be deactivated - active healthcare services exists)
Validate equipment
Check that there are no active records in equipment table related to this division
Search for equipments with this division in ACTIVE status
If search result contains any records - return 409 error (Division cannot be deactivated - active equipments exists)
Validate transition
Only ACTIVE division can be deactivated
Available transitions
ACTIVE → INACTIVE
In other cases - return 409 error ('{current_status} division cannot be DEACTIVATED')
Processing
Save object to DB
Parameter | Source | Description |
---|---|---|
status | INACTIVE |
|
updated_at | Timestamp: now() | Get current date-time |
updated_by | Token: user_id |
|
Deactivate Medical Program Provision
For PHARMACY legal entity type only. For related divisions deactivate linked active medical program provision entities (according to link).
Deactivate related active medical program provision entities:
set is_active = false
set deactivate_reason = AUTO_DIVISION_DEACTIVATION
set updated_at, updated by
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 | Response |
| ||
3 | 401 | Invalid access token |
| ||
4 | 403 | Check that division belongs to the same legal entity as the user failed | |||
5 | 403 | Invalid scope | |||
6 | 404 | Validation error | |||
7 | 409 | {current_status} division cannot be DEACTIVATED | |||
8 | 409 | Division cannot be deactivated - active healthcare services exists | |||
9 | 409 | Validation error | |||
10 | Специфічні | ||||
11 |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used