employees
GET /api/employees
List Employees
Авторизация: Bearer Token
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| organization_id | Organization Id |
Response 200: Successful Response
array[EmployeeResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | нет | |
| first_name | First Name | нет | |
| middle_name | Middle Name | нет | |
| organization_id | Organization Id | нет | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет | |
| id | Id | нет | |
| is_active | Is Active | нет | |
| full_name | Full Name | нет | |
| organization_name | Organization Name | нет | |
| is_confirmed | Is Confirmed | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| suo_sync_status | Suo Sync Status | нет | |
| sync_warnings | array[string] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/employees
Create Employee
Авторизация: Bearer Token
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | да | |
| first_name | First Name | да | |
| middle_name | Middle Name | нет | |
| organization_id | Organization Id | да | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | нет | |
| first_name | First Name | нет | |
| middle_name | Middle Name | нет | |
| organization_id | Organization Id | нет | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет | |
| id | Id | нет | |
| is_active | Is Active | нет | |
| full_name | Full Name | нет | |
| organization_name | Organization Name | нет | |
| is_confirmed | Is Confirmed | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| suo_sync_status | Suo Sync Status | нет | |
| sync_warnings | array[string] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/employees/{employee_id}
Get Employee
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| employee_id | Employee Id |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | нет | |
| first_name | First Name | нет | |
| middle_name | Middle Name | нет | |
| organization_id | Organization Id | нет | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет | |
| id | Id | нет | |
| is_active | Is Active | нет | |
| full_name | Full Name | нет | |
| organization_name | Organization Name | нет | |
| is_confirmed | Is Confirmed | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| suo_sync_status | Suo Sync Status | нет | |
| sync_warnings | array[string] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/employees/{employee_id}
Update Employee
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| employee_id | Employee Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | да | |
| first_name | First Name | да | |
| middle_name | Middle Name | нет | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| last_name | Last Name | нет | |
| first_name | First Name | нет | |
| middle_name | Middle Name | нет | |
| organization_id | Organization Id | нет | |
| position | Position | нет | |
| нет | |||
| phone | Phone | нет | |
| modules | array[string] | нет | |
| user_type | User Type | нет | |
| role | Role | нет | |
| id | Id | нет | |
| is_active | Is Active | нет | |
| full_name | Full Name | нет | |
| organization_name | Organization Name | нет | |
| is_confirmed | Is Confirmed | нет | |
| callbox_sync_status | Callbox Sync Status | нет | |
| suo_sync_status | Suo Sync Status | нет | |
| sync_warnings | array[string] | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/employees/{employee_id}
Delete Employee
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| employee_id | Employee Id |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/employees/{employee_id}/reactivate
Reactivate Employee
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| employee_id | Employee Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| organization_id | Organization Id | да |
Response 200: Successful Response
Нет данных
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/employees/sync/callbox
Sync To Callbox
Авторизация: Bearer Token
Response 200: Successful Response
Нет данных