...
...
...
...
...
...
...
...
...
...
...
...
...
| id | ENT-005-011-001 |
|---|
...
ID метода
...
API-005-011-001-0189
...
Автор
...
Viacheslav Tybin (SoE eHealth)
...
Версія документа
...
1.0
...
Статус документа
...
| Status | ||
|---|---|---|
|
...
Назва метода (укр.)
...
Отримати реквізити декларації через Кабмін
...
Назва метода (eng.)
...
Get declaration details via Cabinet
...
Короткий опис метода
...
Деталі декларації за ID
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 details 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-0191 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/cabinet/declarations/{{id}} |
Scope | declaration:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
Current WS allows to see details of declaration knowing its' id.
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
PHONE_TYPE
CONFIDANT_PERSON_TYPE
GENDER
PREFERRED_WAY_COMMUNICATION
DOCUMENT_TYPE
DOCUMENT_RELATIONSHIP_TYPE
POSITION
EMPLOYEE_TYPE
EMPLOYEE_STATUS
COUNTRY
EDUCATION_DEGREE
QUALIFICATION_TYPE
SPECIALITY_TYPE
SPECIALITY_LEVEL
SPEC_QUALIFICATION_TYPE
SCIENCE_DEGREE
ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
LEGAL_FORM
SPECIALITY_TYPE
...
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
...
...
...
...
Request data validation
Authorize
...
Extract party_user (user_id) from token.
Check if users.person_id=$.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 APIN/A
Response structure examples
...
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 | ||