...
| Page Properties |
|---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/get-person-authentication-methods | Посилання на Apiary або Swagger | Resource | /api/persons/{{id}}/authentication_methods | Посилання на ресурс, наприклад: /api/persons/create | Scope | person:read | Scope для доступу | Components | Patient registry | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not foundmpi/api fe/admin-web | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
...
Global and configurable parameters
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
id | | String | Required | 030d5c41-a945-41ac-89d1-b7c6d1c226c7 |
Request structure
...
Dictionaries
Authorize
Verify the validity of access token
Check user scope person:read in order to perform this action
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9api{{access_token}}
Api-key:uXhEczJ56adsfh3Ri9SUkc4en{{secret}}
Request data validation
Validate request
...
| Expand |
|---|
| title | Response example. Code: 403 |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 403,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"error": {
"type": "forbidden",
"message": "Such person not found"
}
} |
|
Post-processing processes
...
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | Response | | 403 | Such person not found | | 422 | | Validation error |
|
...