Получение списка водителей¶

Получение списка водителей

Запрос (Request)¶

GET-запрос¶

https://sedi.ru:9031/api/SeDiExternalSystems/get-driver-profiles/

Заголовки (Headers)¶

Название	Описание
X-Api-Key	API-ключ
X-Client-ID	Ключ, определяющий партнера

Параметры¶

Название	Описание
query	Фильтр запроса. Тип: DriverProfilesListRequestQuery
limit	Максимальное количество возвращаемых значений. Тип: `Int`
offset	Смещение (от нуля) для запроса следующей партии данных. Тип: `Int`

DriverProfilesListRequestQuery¶

Название	Описание
park	Параметры парка. Тип: ContaDriverProfilesListRequestQueryParkctInfo

DriverProfilesListRequestQueryPark¶

Название	Описание
id	Идентификатор такси-группы. Тип: `String`
driver_profile	Условия по водителям. Тип: DriverProfilesListRequestQueryParkDriverProfile

DriverProfilesListRequestQueryParkDriverProfile¶

Название	Описание
id	Массив идентификаторов водителей. Имеет приоритет перед массивом телефонов. Тип: `String[]`
phone	Массив телефонов водителей. Тип: `String[]`

Пример тела запроса¶

{
  "query": {
    "park": {
      "id": "75169",
      "driver_profile": {
        "id": ["7522113"]
      }
    }
  },
  "limit": 20,
  "offset": 0
}

Ответ¶

200 OK¶

Список водителей получен успешно

Параметры¶

Название	Описание
limit	запрошенное макс.количество. Тип: `Int`
offset	запрошенное смещение. Тип: `Int`
total	имеющееся количество данных по заданным фильтрам запроса. Тип: `Int`
driver_profiles	массив найденных водителей. Тип: DriverProfile[]

DriverProfile¶

Название	Описание
accounts	Массив счетов водителя. Тип: DriverProfileAccount[]
driver_profile	Профиль водителя. Тип: DriverProfileModel

DriverProfileAccount¶

Название	Описание
id	Идентификатор счета. Тип: `String`
balance	Текущий баланс. Тип: `String`
currency	Код валюты. Тип: `String`

DriverProfileModel¶

Название	Описание
id	Идентификатор водителя. Тип: `String`
last_name	Фамилия. Тип: `String`
first_name	Имя. Тип: `String`
middle_name	Отчество. Тип: `String`

{
  {
    "limit": 20,
    "offset": 0,
    "total": 1,
    "driver_profiles": [
        {
            "accounts": [
                {
                    "id": "751322113",
                    "balance": "100.0000",
                    "currency": "RUB"
                }
            ],
            "driver_profile": {
                "id": "7522113",
                "last_name": "Иванов",
                "first_name": "Сергей",
                "middle_name": "Петрович"
            }
        }
    ]
}

}

403 Forbidden¶

Некорректный API KEY.

400 BadRequest¶

Некорректные параметры запроса или пустые заголовки.

500 InternalServerError¶

Ошибка в процессе выполнения запроса

Error. Ошибка добавления¶

{
  "code": "код ошибки",
  "message": "текстовое описание ошибки"
}