...
...
...
...
...
...
...
...
...
...
...
...
...
...
| id | ENT-005-011-001 |
|---|
...
ID метода
...
API-005-011-001-0190
...
Автор
...
Viacheslav Tybin (SoE eHealth)
...
Версія документа
...
1.0
...
Статус документа
...
| Status | ||
|---|---|---|
|
...
Назва метода (укр.)
...
Отримати список декларацій через Кабмін
...
Назва метода (eng.)
...
Get declaration list via Cabinet
...
Короткий опис метода
...
Дозволяє бачити історію всіх декларацій пацієнта та фільтрувати їх.
REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | Get declaration list via Cabinet |
Guideline ID | GUI-0011 |
Author | |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-010-001-0192 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/cabinet/declarations |
Scope | declaration:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS is designed to obtain a declaration list by a patient in a cabinet
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
Configuration parameters
Description of the configuration parameters that are used when processing a request in the systemN/A
Dictionaries
POSITION
LEGAL_FORM
DIVISION_TYPE
DIVISION_STATUS
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | |||||
| 2 |
|
|
|
|
|
Request structure
See on Apiary
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
...
...
Request data validation
...
Mandatory
...
Description
...
Example
...
...
...
...
...
...
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = ''declaration:read")
Return 403 in case invalid scope(s) - "Your scope does not allow to access this resource. Missing allowances: declaration:read"
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = ''declaration:read")
Return 403 in case invalid scope(s) - "Your scope does not allow to access this resource. Missing allowances: declaration:read"
Validate user
Extract party_user (user_id) from token.
Check if party_user=$.declarations.person_id
in case error return 403
check person.tax_id=users.tax_id
in case error return 401 - access denied
Check users password is not expired
in case error return 401 - password expired
Check if users.is_blocked = false
in case error return 401 - access denied
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response |
| ||
| 3 | 401 | Access denied | |||
| 4 | 401 | Password expired | |||
| 5 | 401 | Validation failed | |||
| 6 | 403 | Validation failed | |||
| 7 | 403 | Your scope does not allow to access this resource. Missing allowances: declaration:read | |||
| 8 | Специфічні | ||||
| 9 |
| ||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||