Публичный API [3.0]: Получение данных по водителям
Описание метода
Метод применяется для получения расширенного списка водителей.
Предусловия
- Требуется аутентификация
- Требуется OAuth 2.0 scope "drivers:read"
- Элементы "items" в теле ответа фильтруются по наличию роли с ApiScope "drivers:read" и доступом к DriverGroup.OwnerCompanyId и DriverGroup.ScopesWithAccess
Формат запроса (Request body)
Метод запроса: POST/public/drivers/search
Метод доступен по ссылке.
| Атрибут | Тип | Обязательность | Описание |
| ids | UUID[] | Нет | Идентификаторы водителей |
| page | Integer | Нет | Номер страницы |
Если ids = null, то выдаются все доступные водители. Если заполнен каким-то массивом, то выдаются только те, которые передали.
Пример запроса:
{
"ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"page": 0
}
Формат ответа (Responses Code)
В случае успеха метод возвращает ответ с кодом 200 и телом ответа в формате JSON:
| Атрибут | Тип | Обязательность | Описание | |
| items | Object[] | Да | Массив результатов | |
|
|
Id | UUID | Да | Идентификатор водителя |
|
|
GroupId | UUID | Да | Идентификатор группы водителей |
|
|
FullName | String | Да | Фамилия Имя Отчество водителя |
|
|
MainPhoneNumber | String | Нет | Телефон для связи |
|
|
Comment | String | Нет | Комментарий |
|
|
EmployeeNumber | String | Нет | Табельный номер |
|
|
ContractType | NoneStaffExternal | Да | Тип трудоустройства |
| isLast | Boolean | Да | Признак последней части | |
Пример ответа:
{
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fullName": "string",
"mainPhoneNumber": "string",
"comment": "string",
"employeeNumber": "string",
"contractType": "None"
}
],
"isLast": true
}
В случае ошибок авторизации или валидации запроса метод возвращает код, соответствующий ошибке, и тело в формате JSON, соответствующее формату Problem Details:
| Тело ответа | Тип | Обязательность | Описание | |
| type | String | Да | Тип ошибки | |
| title | String | Да | Человекочитаемая расшифровка типа ошибки (универсальная для всех запросов) | |
| detail | String | Нет | Комментарий к ошибке (специфичный для этого запроса) | |
| errors | Object[] | Нет | Массив детализированных ошибок | |
| key | enum ErrorKey | Да | Тип ошибки | |
| 401 | Unautorized | Токен невалидный или истек срок действия | ||
| 403 | DriverInaccessible | Нет роли с ApiScope "drivers:read" и доступом к DriverGroup.OwnerCompanyId и DriverGroup.ScopesWithAccess | ||
| 400 | Format | Некорректный формат query параметра | ||
| 404 | DriverNotFound | Запрашиваемый по Id водитель не найден в системе | ||
| 404 | PageNotFound | Запрашиваемая страница не найдена (page меньше минимального значения или page больше максимального значения) | ||
| 500 | InternalError | Произвольная ошибка на сервере | ||
| values | String[] | Да | Список сообщений к данной ошибке | |