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

Operators

GET /api/organizations/{tenant_id}/operators/available-users

Get Available Users

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

Path параметры:

Параметр Тип Описание
tenant_id Tenant Id

Response 200: Successful Response

array[AvailableUserResponse]

Поле Тип Обязательное Описание
id Id нет
email Email нет
first_name First Name нет
last_name Last Name нет
full_name Full Name нет

Ошибки:

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

GET /api/organizations/{tenant_id}/operators/

Get Operators

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

Path параметры:

Параметр Тип Описание
tenant_id Tenant Id

Query параметры:

Параметр Тип По умолчанию Описание
skip Skip 0
limit Limit 100
include_inactive Include Inactive False Включить деактивированных операторов

Response 200: Successful Response

array[OperatorResponse]

Поле Тип Обязательное Описание
id Id нет
tenant_id Tenant Id нет
org_id Org Id нет
operator_num Operator Num нет
operator_name Operator Name нет
user_id User Id нет
is_active Is Active нет

Ошибки:

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

POST /api/organizations/{tenant_id}/operators/

Create Operator

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

Path параметры:

Параметр Тип Описание
tenant_id Tenant Id

Request Body:

Поле Тип Обязательное Описание
operator_num Operator Num да Номер оператора (3 цифры, 000-999)
user_id User Id да ID пользователя из organization_users

Response 201: Successful Response

Поле Тип Обязательное Описание
id Id нет
tenant_id Tenant Id нет
org_id Org Id нет
operator_num Operator Num нет
operator_name Operator Name нет
user_id User Id нет
is_active Is Active нет

Ошибки:

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

GET /api/organizations/{tenant_id}/operators/{operator_id}

Get Operator

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

Path параметры:

Параметр Тип Описание
operator_id Operator Id
tenant_id Tenant Id

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
tenant_id Tenant Id нет
org_id Org Id нет
operator_num Operator Num нет
operator_name Operator Name нет
user_id User Id нет
is_active Is Active нет

Ошибки:

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

PUT /api/organizations/{tenant_id}/operators/{operator_id}

Update Operator

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

Path параметры:

Параметр Тип Описание
tenant_id Tenant Id
operator_id Operator Id

Request Body:

Поле Тип Обязательное Описание
operator_num Operator Num нет Номер оператора (3 цифры, 000-999)
user_id User Id нет ID пользователя (можно изменить привязку)
is_active Is Active нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
tenant_id Tenant Id нет
org_id Org Id нет
operator_num Operator Num нет
operator_name Operator Name нет
user_id User Id нет
is_active Is Active нет

Ошибки:

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

DELETE /api/organizations/{tenant_id}/operators/{operator_id}

Delete Operator

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

Path параметры:

Параметр Тип Описание
tenant_id Tenant Id
operator_id Operator Id

Response 200: Successful Response

Нет данных

Ошибки:

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