ЕСОЗ - публічна документація
Activate Division
Purpose
This method should be used to activate division
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/divisions/{{id}}/actions/activate | Посилання на ресурс, наприклад: /api/persons/create |
Scope | division:activate | Scope для доступу |
Components | Divisions | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | il/api | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | PATCH | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
Logic
Only authenticated and authorized user can use this service
Only INACTIVE division can be activated
Legal entity can activate only its own divisions
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Dictionaries
Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'division:activate')
Return 403 in case invalid scope(s)
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
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 transition
Only INACTIVE divisions can be activated
Available transitions
INACTIVE → ACTIVE
In other cases - return 409 error ('{current_status} division cannot be ACTIVATED')
Processing
Save object to DB
Parameter | Source | Description |
---|---|---|
status | ACTIVE |
|
updated_at | Timestamp: now() | Get current date-time |
updated_by | Token: user_id |
|
Response structure
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 |
| Invalid access token |
403 |
|
|
404 |
| Validation error |
409 |
| Validation error |
ЕСОЗ - публічна документація