...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| id | ENT-005-011-006 |
|---|
...
ID метода | API-005-011-006-0202 | ||||
|---|---|---|---|---|---|
Автор | |||||
Версія документа | 1.0 | ||||
Статус документа |
| ||||
Назва метода (укр.) | Отримати фактор автентифікації | ||||
Назва метода (eng.) | Get authentication factor | ||||
Короткий опис метода | Щоб бачити номер 2FA в кабінеті. |
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 authentication factor |
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-0206 |
Microservices (namespace) | IL |
Component | Patient Cabinet |
Component ID | COM-005-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/cabinet/authentication_factor |
Scope | person:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
This WS allows to see 2FA number via Cabinet.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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 parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Search authentication factor by user
SELECT id, type, factor, is_active, user_id FROM authentication_factors where user_id=$user_id;
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 (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response |
| ||
| 3 | 401 | Access denied | Validation failed | ||
| 4 | 401 | User blocked | |||
| 5 | 401 | Unauthorized |
| Помилка підтвердження | |
| 6 | 403 | Your scope does not allow to access this resource. Missing allowances: "person:read" | Validation failed | ||
| 7 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 8 | 404 | Token was not found | Validation failed | ||
| 9 | 409 | Person is not active | Validation failed | ||
| 10 | Специфічні | ||||
| 11 |
| 422 | Only for active MPI record can be created medication request! |
|
|
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||