Shared Organizations
GET /api/shared/organizations
List Organizations
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| region_id | Region Id | ||
| oblast_id | Oblast Id | ||
| show_inactive | Show Inactive | False |
Response 200: Successful Response
array[OrganizationResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| region_id | Region Id | нет | |
| region_name | Region Name | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет | |
| groups | array[object] | нет | |
| employee_count | Employee Count | нет | |
| modules | array[string] | нет | |
| prefix | Prefix | нет | |
| is_active | Is Active | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| callbox_sync_error | Callbox Sync Error | нет | |
| callbox_synced_at | Callbox Synced At | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/shared/organizations
Create Organization
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | да | |
| region_id | Region Id | да | |
| group_ids | array[integer] | нет | |
| modules | array[string] | нет | |
| prefix | Prefix | да |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| region_id | Region Id | нет | |
| region_name | Region Name | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет | |
| groups | array[object] | нет | |
| employee_count | Employee Count | нет | |
| modules | array[string] | нет | |
| prefix | Prefix | нет | |
| is_active | Is Active | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| callbox_sync_error | Callbox Sync Error | нет | |
| callbox_synced_at | Callbox Synced At | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/shared/organizations/{org_id}
Get Organization
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| org_id | Org Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| region_id | Region Id | нет | |
| region_name | Region Name | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет | |
| groups | array[object] | нет | |
| employee_count | Employee Count | нет | |
| modules | array[string] | нет | |
| prefix | Prefix | нет | |
| is_active | Is Active | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| callbox_sync_error | Callbox Sync Error | нет | |
| callbox_synced_at | Callbox Synced At | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/shared/organizations/{org_id}
Update Organization
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| org_id | Org Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | да | |
| region_id | Region Id | да | |
| group_ids | array[integer] | нет | |
| modules | array[string] | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | Id | нет | |
| name | Name | нет | |
| region_id | Region Id | нет | |
| region_name | Region Name | нет | |
| oblast_id | Oblast Id | нет | |
| oblast_name | Oblast Name | нет | |
| city_name | City Name | нет | |
| groups | array[object] | нет | |
| employee_count | Employee Count | нет | |
| modules | array[string] | нет | |
| prefix | Prefix | нет | |
| is_active | Is Active | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| callbox_sync_error | Callbox Sync Error | нет | |
| callbox_synced_at | Callbox Synced At | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/shared/organizations/{org_id}
Delete Organization
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| org_id | Org Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/shared/organizations/{org_id}/retry-callbox-sync
Retry Callbox Sync
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| org_id | Org Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/shared/organizations/retry-all-failed-callbox
Retry All Failed Callbox
Response 200: Successful Response
Нет данных