...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Purpose
API paragraph not found
Specification
...
або Swagger | Resource | api/employee_roles/{{id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | employee_roles:read | Scope для доступу | Components | Scopes model | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
Only authenticated and authorized user can use this service
Service returns only employee roles related to the same legal entity as the user
...
Request structure
API paragraph not found
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'employee_role:read')
Return 403 in case invalid scope(s)
...
Наприклад:
Content-Type:application/json
Request data validation
Check that employee
...
role with such ID exists in the system (is_active = true)
In case of error - return 404
Check that employee role with such ID belongs
...
to to the same legal entity as the user
In case of error - return 403
...
Prepare response
...
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": {
"id": "7c3da506-804d-4550-8993-bf17f9ee0402",
"healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
"employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd",
"start_date": "2019-04-20T19:14:13Z",
"end_date": "2017-12-20T19:14:13Z",
"status": "ACTIVE",
"is_active": true,
"inserted_at": "2017-04-20T19:14:13Z",
"inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
"updated_at": "2017-04-20T19:14:13Z",
"updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
}
} |
|
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
201 | Response | | 401 | | Invalid access token | 403 | | | 404 | | Check that employee role with such ID exists in the system (is_active = true) failed |
|