запрос getPerformers
Для получения списка водителей в рамках одного распределительного центра (области контроля) API использует структуру application/x-www-form-urlencoded l и HTTP запрос POST
Входные данные запроса getPerformers
Входные данные должны отправляться как атрибуты и не должны находиться в теле запроса. Список всех поддерживаемых атрибутов представлен ниже.
# | Название атрибута | Тип | Стиль | Обязательность | Описание |
1 | sessionID | Текст |
| Да | Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут |
2 | aocID | Целое число | Query | Да | Идентификатор распределительного центра в приложении |
3 | date | Дата | Query | Да | Запрашиваемая дата. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY”. Для России – “ДД.MM.ГГГГ” |
Пример запроса getPerformers
Заголовки:
URL: /rest/2/distribution-api/objects/getPerformers?sessionID=94bb1165ed40419dbecde6910fb1bff1&date=12.10.2014&aocID=337Метод: POST
Структура: application/x-www-form-urlencoded
Тело запроса: не должно содержать никакой информации
ответ getPerformers
Для получения списка водителей в рамках одного распределительного центра (области контроля) API использует структуру application/xml как структуру ответа
Выходные данные ответа getPerformers
# | Название поля | Описание |
1 | performersResponse |
|
1.1 | performers |
|
1.1.1 | performer |
|
| Атрибут “id” | Идентификатор водителя в аккаунте, который может быть использован в дальнейших вопросах |
| Атрибут “name” | Имя водителя |
| Атрибут “driverPhone” | Телефонный номер водителя |
| Атрибут “vehicleName” | Имя транспортного средства |
| Атрибут “costPerHour” | Стоимость за 1 час работы |
| Атрибут “startTime” | Время начала доступности водителя |
| Атрибут “endTime” | Время окончания доступности водителя |
| Атрибут “aocId” | Идентификатор распределительного центра, которому принадлежит водитель |
| Атрибут “fixedDayStart” | Признак того что водитель должен начать рейс в момент начала его рабочей смены |
| Атрибут “scheduleZonesId” | Список зон планирования, которые могут обслуживаться данным водителем. |
Пример ответа getPerformers
<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?>
<apiResponse version=”1.0”>
<performersResponse>
<performers>
<performer id=”7143” name=”Водитель А003ТЕ” driverPhone=”356-56-84” vehicleName=”А003ТЕ” costPerHour=”0” startTime=”12.10.2014 06:00” endTime=”12.10.2014 21:00” fixedDayStart=”false” aocId=”337” scheduleZonesId=”36, 37”/>
<performer id=”7058” name=”Водитель А584КМ” driverPhone=”654-85-89” vehicleName=”А584КМ” costPerHour=”0” startTime=”12.10.2014 06:00” endTime=”12.10.2014 21:00” fixedDayStart=”false” aocId=”337” scheduleZonesId=”42, 43”/>
</performers>
</performersResponse>
</apiResponse>