REST API method / Метод REST API (настанова) /wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] Get declaration list via Cabinet [API-005-010-001-0192] |
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 |
...
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | |||||
| 2 |
|
|
|
|
|
Request structure
...
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
...
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 APIN/A
Response structure examples
...
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...