...
| Page Properties |
|---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/get-person-verification-details | Посилання на Apiary або Swagger | Resource | /api/persons/{{id}}/verification | Посилання на ресурс, наприклад: /api/persons/create | Scope | person:read | Scope для доступу | Components | Patient registry | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | mpi/api il/api (rpc) 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
Service returns verification info for a specified person:
...
Verify the validity of access token
Verify that token is not expired
Check user scopes in order to perform this action (scope = 'person:read')
Наприклад:
Content-Type:application/json
Authorization:Bearer {{access_token}}
api-key: {{secret}}
...
Get Patient identifier from the URL
Check it exists in DB
Processing
...
Response structure
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": {
"verification_status": "NOT_VERIFIED",
"verification_reason": "MANUAL",
"verification_comment": "Бракує даних паспорту пацієнта та його ІПН"
}
} |
|
Post-processing processes
...
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | Response | | 401 | Invalid access token | | 403 | Your scope does not allow to access this resource. Missing allowances: person:read | | 404 | not found | |
|
...