ЕСОЗ - публічна документація
Get divisions
Purpose
This WS allows to get a list of divisions of legal entity. Also, this list can be filtered using search parameters.
Only authenticated and authorized owners with appropriate scope can get a list of divisions.
Method returns a list of divisions for user’s legal entity only.
List can be filtered by search params.
Logic
Get client_id from token as legal entity identifier
Define all the divisions of the legal entity
Get and render all the records with defined divisions from divisions table filtered by search params.
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/divisions | Посилання на ресурс, наприклад: /api/persons/create |
Scope | division:read | Scope для доступу |
Components | Divisions | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | il/api | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
Filters
All search params are optional. Search with a few params executes according to the logical AND rule.
ids
If submitted, filter list by divisions.id
name
If submitted, filter list by divisions.name
legal_entity_id
If submitted, filter list by divisions.legal_entity_id
type
If submitted, filter list by divisions.type
status
If submitted, filter list by divisions.status
See on Apiary
Authorize
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 = 'division:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: division:read” in case of invalid scope(s)
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'division:read')
in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: division:read”
Check legal entity status (status = ACTIVE, SUSPENDED)
In case of error - return 422 “Legal entity is not active”
Response structure
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 |
| Authorization failed |
403 |
| Invalid scopes |
422 |
| Validation failed |
ЕСОЗ - публічна документація