...
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
/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 Personal info [API-005-010-006-0207] |
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-006-0207 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | https://ehealthmisapi1.docs.apiary.io/#reference/public.-patient-cabinet/cabinet/get-personal-info |
Resource | {{host}}/api/cabinet/persons |
Scope | |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS is designed to get the personal information of patient by token
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 system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | composition_id | M | String ($uuid) (path) | Composition object ID89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | ||||||
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
...
...
Request data validation
Validate token
Check token existance
in case error return 404 - token was not found
Check expiration date tokens.expires_at
if tokens.expires_at < now() return 401 - access denied
Extract user_id from token
Validate role
Check users_roles.user_id=&.user and user_roles.role_id = roles.id where roles.name = CABINET
in case error return 403
Validate person
Check if mithril.users.person_id = mpi.persons.id and mithril.users.tax_id = mpi.persons.tax_id
in case error return 401
Check if users.is_blocked = false
in case error return 401
Check users password is not expired
in case error return 401 - password expired
Processing
In case nothing found return 404 - user was not found
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||
| 2 | 200 | Response |
| |||||||
| 3 | 401 |
| Validation failed | |||||||
| 4 | 401 | Unauthorized |
| Помилка підтвердження | 5 | 403 |
| Validation failed | ||
| 65 | 404 |
| Validation failed | |||||||
| 7 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | |||||
| 8 | Специфічні | |||||||||
| 9 |
| 422 | Only for active MPI record can be created medication request! | 6 | Специфічні | |||||
| 7 |
| |||||||||
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 | ||
...