<aside> <img src="/icons/info-alternate_gray.svg" alt="/icons/info-alternate_gray.svg" width="40px" />

Ендпоінти сервісу user-management-service, які використовуються для отримання даних організації та ролей користувача в цій організації.

</aside>

<aside> <img src="/icons/list-indent_gray.svg" alt="/icons/list-indent_gray.svg" width="40px" />

Зміст

</aside>

1. Отримання даних організації

<aside> <img src="/icons/info-alternate_gray.svg" alt="/icons/info-alternate_gray.svg" width="40px" />

Ідентифікатор організації користувача зашиті в токен.

</aside>

<aside> <img src="/icons/swap-horizontally_gray.svg" alt="/icons/swap-horizontally_gray.svg" width="40px" /> Щоб отримати повну інформацію про організацію користувача необхідно виконати GET запит на ендпоінт /v1/organizations/{id}.

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Параметри запиту

Параметр Тип Обов’язково Приклад значення Опис
id int Так 17 Ідентифікатор організації. Передається в заголовку.

<aside> <img src="/icons/forward_gray.svg" alt="/icons/forward_gray.svg" width="40px" /> Приклад запиту

<https://user-management-service-stage.es.meddata.com.ua/v1/organizations/17>

</aside>

</aside>

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Параметри відповіді

Параметр Тип Приклад значення Опис
id integer 17 Ідентифікатор організації.
code string "00000003" Код (ЄДРПОУ) організації.
fullName string "Лікарня № 3 ТЕСТ”
fullNameUa string "Лікарня № 3 ТЕСТ”
fullNameEn string "Hospital No. 3 TEST"
shortName string "\\\"Лікарня №3\\\" ТЕСТ"
shortNameUa string "\\\"Лікарня №3\\\" ТЕСТ"
shortNameEn string "Hospital No. 3 TEST"
legalForm string "Комунальне підприємство" Організаційно-правова форма.
subordinatedToId integer 16 Ідентифікатор батьківської організації.
subordinatedToFullName string “Організація регіонального рівня 002 ТЕСТ”
subordinatedToFullNameUa string “Організація регіонального рівня 002 ТЕСТ”
subordinatedToFullNameEn string “Organization of the regional level 002 TEST” Повна назва батьківської організації англійською.
subordinatedToShortName string “ОРР 002 ТЕСТ”
subordinatedToShortNameUa string “ОРР 002 ТЕСТ”
subordinatedToShortNameEn string “ORL 002 TEST”
status string “ACTIVE” Статус організації.
type string “ZOZ” Тип організації.
memberConnectionStatus string "CONNECTED" Статус користувача в організації.
createdAt string "2022-12-28T13:30:21.608694Z" Дата створення організації.
approvedAt string "2022-12-28T13:30:47.083991Z" Дата погодження (верифікації) організації.
createdByUser string “” Автор створення організації.
approvedByUser string “” Автор погодження (верифікації) організації.

<aside> <img src="/icons/backward_gray.svg" alt="/icons/backward_gray.svg" width="40px" /> Приклад відповіді

{
    "id": 17,
    "code": "00000003",
    "fullName": "Лікарня № 3 | ТЕСТ",
    "fullNameUa": "Лікарня № 3 | ТЕСТ",
    "fullNameEn": "Hospital No. 3 | TEST",
    "shortName": "\\\\\\"Лікарня №3\\\\\\" | ТЕСТ",
    "shortNameUa": "\\\\\\"Лікарня №3\\\\\\" | ТЕСТ",
    "shortNameEn": "Hospital No. 3 | TEST",
    "legalForm": "Комунальне підприємство",
    "subordinatedToId": 16,
    "subordinatedToFullName": "Організація регіонального рівня 002 | ТЕСТ",
    "subordinatedToFullNameUa": "Організація регіонального рівня 002 | ТЕСТ",
    "subordinatedToFullNameEn": "Organization of the regional level 002 TEST",
    "subordinatedToShortName": "ОРР 002 | ТЕСТ",
    "subordinatedToShortNameUa": "ОРР 002 | ТЕСТ",
    "subordinatedToShortNameEn": "ORL 002 | TEST",
    "status": "ACTIVE",
    "type": "ZOZ",
    "memberConnectionStatus": "CONNECTED",
    "createdAt": "2022-12-28T13:30:21.608694Z",
    "approvedAt": "2022-12-28T13:30:47.083991Z",
    "createdByUser": null,
    "approvedByUser": null
}

</aside>

</aside>

<aside> <img src="/icons/no_gray.svg" alt="/icons/no_gray.svg" width="40px" /> Помилки

Параметр Опис
status Статус відповіді.
detail Деталі відповіді.
code Код помилки. Можливі коди помилок можна переглянути за посиланням.
localizedMessage Локалізований текст помилки.

<aside> <img src="/icons/backward_gray.svg" alt="/icons/backward_gray.svg" width="40px" /> Приклад відповіді

{
    "title": "Bad Request",
    "status": 400,
    "detail": "A patient management is available only for requisition that is in draft status. Requisition id: 658, current requisition status: ARCHIVED",
    "code": "400.notdraftmodificationexception",
    "localizedMessage": "Заявку на потребу можливо відредагувати лише в статусі 'Чернетка'"
}

</aside>

</aside>

</aside>

2. Отримання ролей користувача в організації

<aside> <img src="/icons/swap-horizontally_gray.svg" alt="/icons/swap-horizontally_gray.svg" width="40px" />

Щоб отримати дані організації необхідно виконати GET запит на ендпоінт /v1/users/organizations/{organizationId}/roles.

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Параметри запиту

Параметр Тип Приклад значення Опис
organizationId string 17 Ідентифікатор заявки на потребу. Передається в заголовку.

<aside> <img src="/icons/forward_gray.svg" alt="/icons/forward_gray.svg" width="40px" /> Приклад запиту

<https://user-management-service-stage.es.meddata.com.ua/v1/users/organizations/17/roles>

</aside>

</aside>

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Параметри відповіді

Параметр Тип Приклад значення Опис
roles array "signer-organization-role","zoz-member-role" Перелік ролей користувача в поточній організації.

<aside> <img src="/icons/backward_gray.svg" alt="/icons/backward_gray.svg" width="40px" /> Приклад відповіді

{"roles":["signer-organization-role","zoz-member-role"]}

</aside>

</aside>

</aside>