Organizations
GET /api/organizations/
Get Organizations
Авторизация: Bearer Token
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| skip | Skip | 0 | |
| limit | Limit | 1000 | |
| include_inactive | Include Inactive | False | |
| oblast_id | Oblast Id |
Response 200: Successful Response
array[OrganizationResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | нет | Название организации |
| org_prefix | Org Prefix | нет | Префикс организации (3 цифры) |
| is_active | Is Active | нет | Активна ли организация |
| max_queues | Max Queues | нет | Максимум очередей |
| max_operators | Max Operators | нет | Максимум операторов |
| id | Id | нет | |
| created_at | Created At | нет | |
| queues_count | Queues Count | нет | |
| operators_count | Operators Count | нет | |
| endpoints_count | Endpoints Count | нет | |
| routes_count | Routes Count | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/
Create Organization
Авторизация: Bearer Token
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | да | |
| org_prefix | Org Prefix | да | Префикс: 3 цифры (000-999) |
| is_active | Is Active | нет | |
| max_queues | Max Queues | нет | |
| max_operators | Max Operators | нет |
Response 201: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | нет | Название организации |
| org_prefix | Org Prefix | нет | Префикс организации (3 цифры) |
| is_active | Is Active | нет | Активна ли организация |
| max_queues | Max Queues | нет | Максимум очередей |
| max_operators | Max Operators | нет | Максимум операторов |
| id | Id | нет | |
| created_at | Created At | нет | |
| queues_count | Queues Count | нет | |
| operators_count | Operators Count | нет | |
| endpoints_count | Endpoints Count | нет | |
| routes_count | Routes Count | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/search
Search Organization By Uuid
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| kmis_uuid | Kmis Uuid |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{organization_id}
Get Organization
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | нет | Название организации |
| org_prefix | Org Prefix | нет | Префикс организации (3 цифры) |
| is_active | Is Active | нет | Активна ли организация |
| max_queues | Max Queues | нет | Максимум очередей |
| max_operators | Max Operators | нет | Максимум операторов |
| id | Id | нет | |
| created_at | Created At | нет | |
| queues_count | Queues Count | нет | |
| operators_count | Operators Count | нет | |
| endpoints_count | Endpoints Count | нет | |
| routes_count | Routes Count | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/organizations/{organization_id}
Update Organization
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | нет | |
| org_prefix | Org Prefix | нет | |
| is_active | Is Active | нет | |
| max_queues | Max Queues | нет | |
| max_operators | Max Operators | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| org_name | Org Name | нет | Название организации |
| org_prefix | Org Prefix | нет | Префикс организации (3 цифры) |
| is_active | Is Active | нет | Активна ли организация |
| max_queues | Max Queues | нет | Максимум очередей |
| max_operators | Max Operators | нет | Максимум операторов |
| id | Id | нет | |
| created_at | Created At | нет | |
| queues_count | Queues Count | нет | |
| operators_count | Operators Count | нет | |
| endpoints_count | Endpoints Count | нет | |
| routes_count | Routes Count | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/organizations/{organization_id}
Delete Organization
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{organization_id}/notifications
Get Notification Settings
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/organizations/{organization_id}/notifications
Save Notification Settings
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| is_active | Is Active | нет | Активны ли автооповещения |
| kmis_uuid | Kmis Uuid | нет | UUID организации в КМИС |
| call_local | Call Local | нет | Разрешение местных звонков |
| call_longdistance | Call Longdistance | нет | Разрешение междугородных звонков |
| call_mobile | Call Mobile | нет | Разрешение мобильных звонков |
| cli_route_id | Cli Route Id | нет | ID маршрута для CLI |
| sms_enabled | Sms Enabled | нет | Разрешение СМС |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/{organization_id}/notifications
Save Notification Settings
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| organization_id | Organization Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| is_active | Is Active | нет | Активны ли автооповещения |
| kmis_uuid | Kmis Uuid | нет | UUID организации в КМИС |
| call_local | Call Local | нет | Разрешение местных звонков |
| call_longdistance | Call Longdistance | нет | Разрешение междугородных звонков |
| call_mobile | Call Mobile | нет | Разрешение мобильных звонков |
| cli_route_id | Cli Route Id | нет | ID маршрута для CLI |
| sms_enabled | Sms Enabled | нет | Разрешение СМС |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |