Перейти к содержанию

users

POST /api/users/ensure

Ensure User

Request Body:

Поле Тип Обязательное Описание
shared_employee_id Shared Employee Id да
shared_org_id Shared Org Id да
is_active Is Active да

Response 200: Successful Response

Поле Тип Обязательное Описание
status Status нет
shared_employee_id Shared Employee Id нет

Ошибки:

Код Описание
422 Validation Error

GET /api/users

List Users

Авторизация: Bearer Token

Query параметры:

Параметр Тип По умолчанию Описание
organization_id Organization Id
include_inactive Include Inactive False

Response 200: Successful Response

array[UserResponse]

Поле Тип Обязательное Описание
id Id нет
shared_employee_id Shared Employee Id нет
suo_organization_id Suo Organization Id нет
full_name Full Name нет
email Email нет
phone Phone нет
position Position нет
is_active Is Active нет
supervisor_id Supervisor Id нет
supervisor_name Supervisor Name нет
roles array[object] нет

Ошибки:

Код Описание
422 Validation Error

PUT /api/users/{user_id}/roles

Update User Roles

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
user_id User Id

Request Body:

Поле Тип Обязательное Описание
roles array[object] да

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
shared_employee_id Shared Employee Id нет
suo_organization_id Suo Organization Id нет
full_name Full Name нет
email Email нет
phone Phone нет
position Position нет
is_active Is Active нет
supervisor_id Supervisor Id нет
supervisor_name Supervisor Name нет
roles array[object] нет

Ошибки:

Код Описание
422 Validation Error

PUT /api/users/{user_id}/supervisor

Update Supervisor

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
user_id User Id

Request Body:

Поле Тип Обязательное Описание
supervisor_id Supervisor Id нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
shared_employee_id Shared Employee Id нет
suo_organization_id Suo Organization Id нет
full_name Full Name нет
email Email нет
phone Phone нет
position Position нет
is_active Is Active нет
supervisor_id Supervisor Id нет
supervisor_name Supervisor Name нет
roles array[object] нет

Ошибки:

Код Описание
422 Validation Error

GET /api/users/{user_id}/operator-info

Get User Operator Info

Авторизация: Bearer Token

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
operator_id Operator Id нет
operator_num Operator Num нет

Ошибки:

Код Описание
422 Validation Error