Purpose
...
| Page Properties |
|---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/roles/get-role-by-id | Посилання на Apiary або Swagger | Resource | /admin/roles/{{id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | role: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 | Потрібно зазначити тип методу за ступенем доступності |
|
Preconditions
Logic
API paragraph not foundThis method returns role details (id/name/scopes) from mithril.roles by Role_ID
Global and configuration parameters
...
API paragraph not found
Authorize
...
Verify the validity of access token
in case error return 401 Unauthorized
Check users scopes (role:read) to perform this action
in case error return 403 - forbidden
API paragraph not found
...
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | Response | | 404 | not_found | role with this ID not found in DB | 401 | Unauthorized | invalid token |
|
Backward compatibility
API paragraph not found