запрос exportPerformers
Запрос используется для экспорта водителей (Performers) из системы
Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/exportPerformers
Список поддерживаемых атрибутов:
№ | Название поля | Обязательное | Описание |
1 | performer | Блок информации о водителе | |
1.1 | externalId | Нет | Внешний идентификатор водителя. Поле выгружается только в том случае, если оно было заполнено при создании водителя. |
1.2 | globalId | Да | Глобальный идентификатор водителя. Поле заполняется автоматически при создании водителя, выгружается всегда. |
1.3 | login | Да | Логин водителя. Должен быть уникальным для каждого водителя. |
1.4 | passwordHash | Да | Пароль |
1.5 | name | Да | Имя |
1.6 | Да | Адрес электронной почты | |
1.7 | phone | Нет | Номер телефона |
1.8 | comments | Нет | Комментарии |
1.9 | priceForOneHour | Да | Стоимость одного часа |
1.10 | breakShift | Да | Обязательно, если включены фиксированные обеды. Сдвиг обеда |
1.11 | areaOfControl | Да | Распределительный центр |
1.12 | allowDailyDrivingLimit | Нет | Лимит на вождение за смену. Значения: true / false. |
1.13 | dailyDrivingLimit | Нет | Значение лимита за смену (указывается в минутах) |
1.14 | allowDailyWorkingLimit | Нет | Продолжительность работы за смену. Значения: true / false. |
1.15 | dailyWorkingLimit | Нет | Продолжительность рабочего дня за смену (указывается в минутах). |
1.16 | scheduleZonesId | Нет | Идентификатор территории |
2 | availability | Блок информации о графике работы водителя | |
2.1 | weekDay | Да | День работы. Возможные значения: sunday, monday, tuesday, wednesday, thursday, friday, saturday |
2.2 | from | Да | Начало рабочего дня: с ... часов |
2.3 | to | Да | Окончание рабочего дня: до ... часов |
2.4 | startDayShift | Нет | Значение 0 или -1, если не задан - считается что текущий день. -1: предыдущий день 0: текущий день |
2.5 | endDayShift | Нет | Значение 0 или 1 или 2, если не задан - считается что текущий день 0: текущий день 1: следующий день 2: плюс два дня 3: плюс три дня 4: плюс четыре дня |
2.6 | breakFrom | Да | Обязательный при указании breakTo. Означает - Обед с |
2.7 | breakTo | Да | Обязательный при указании breakFrom. Означает - Обед до |
2.8 | fixedDayStart | Нет | Фиксированное начало рабочего дня |
3 | units | Блок со значениями единиц измерений | |
3.1 | timeZone | Нет | Таймзона |
3.2 | timeZoneOffset | Да | Часовой пояс |
3.3 | currency | Да | Валюта |
3.4 | distanceUnits | Да | Единицы измерения расстояния |
3.5 | speedUnits | Да | Единицы измерения скорости. Значения: METERS_PER_SEC KILOMETERS_PER_HOUR MILES_PER_HOUR. |
3.6 | durationUnits | Да | Единицы измерения погрузки |
3.7 | weightUnits | Да | Единицы измерения веса |
3.8 | volumeUnits | Да | Единицы измерения объема |
4 | zone | Блок, в котором указывается территория, на которой может работать водитель | |
4.1 | name | Нет | Название территории |
5 | start location | Нет | Блок информации об адресе начала рабочего дня. Если start location не используются, не заполнять данный блок. |
5.1 | startLocation address | Да | Адрес локации |
5.2 | latitude | Нет | Долгота |
5.3 | longitude | Нет | Широта |
6 | home location | Блок информации об адресе возврата в конце дня. Если home location не используются, не заполнять данный блок. | |
6.1 | address | Да | Адрес локации |
6.2 | latitude | Нет | Долгота |
6.3 | longitude | Нет | Широта |
Значение полей dailyDrivingLimit и dailyDrivingLimit имеют смысл только при наличии включенных полей allowDailyDrivingLimit и allowDailyWorkingLimit соответственно
Содержит параметр sessionID
URL: rest/2/distribution-api/objects/exportPerformers?sessionID=a5fad852a18149468d1b9845bbd8e1a8
Возвращает ответ
<?xml version="1.0" encoding="UTF-8"?> <apiResponse version="1.0"> <performersDetails> <units timeZone="GMT+01:00" timeZoneOffset="GMT+1:00" currency="POUND" distanceUnits="MILE" speedUnits="MILES_PER_HOUR" durationUnits="MINUTE" weightUnits="units" /> <performers> <performer name="Водитель Иванов" externalId="2675" globalId="2675d0e99a1047e6bd0ebafc326bb939" email="ivanov_magenta_voditel@gmail.com" login="ivanov" passwordHash="42767516990368493138776584305024125808" maxWorkingHours="40" allowedOvertimePerWeek="0" priceForOneHour="0" dailyDrivingLimit="480" allowDailyDrivingLimit="false" dailyWorkingLimit="660" allowDailyWorkingLimit="false" breakShift="0" areaOfControl="FrogwellZone"> <startLocation address="10 Bishops Park Road, London, SW6 6DZ" latitude="" longitude="" /> <homeLocation address="Drake Crescent, Chippenham, Wiltshire, SN14, GB" latitude="51.453891" longitude="-2.148895" /> <availabilities> <availability weekDay="thursday" from="06:00" to="22:00" fixedDayStart="false" /> </availabilities> </performer> </performers> </performersDetails> </apiResponse>