exportPerformers

Owned by Former user (Deleted)
Last updated: Jun 16, 2022 by Admin Doc Maxoptra
2 min read


запрос exportPerformers

Запрос используется для экспорта водителей (Performers) из системы

Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/exportPerformers


Список поддерживаемых атрибутов:

№Название поляОбязательноеОписание
1performer
Блок информации о водителе
1.1

externalId

НетВнешний идентификатор водителя. Поле выгружается только в том случае, если оно было заполнено при создании водителя.
1.2globalIdДаГлобальный идентификатор водителя. Поле заполняется автоматически при создании водителя, выгружается всегда.
1.3login ДаЛогин водителя. Должен быть уникальным для каждого водителя.
1.4passwordHash  ДаПароль
1.5nameДаИмя
1.6emailДаАдрес электронной почты
1.7phoneНетНомер телефона
1.8commentsНетКомментарии
1.9priceForOneHourДаСтоимость одного часа
1.10breakShiftДаОбязательно, если включены фиксированные обеды. Сдвиг обеда
1.11areaOfControlДаРаспределительный центр
1.12

allowDailyDrivingLimit

НетЛимит на вождение за смену. Значения: true / false.
1.13

dailyDrivingLimit

НетЗначение лимита за смену (указывается в минутах)
1.14

allowDailyWorkingLimit

НетПродолжительность работы за смену. Значения: true / false.
1.15

dailyWorkingLimit

НетПродолжительность рабочего дня за смену (указывается в минутах).
1.16

scheduleZonesId

НетИдентификатор территории
2availability
Блок информации о графике работы водителя
2.1weekDayДаДень работы. Возможные значения: sunday, monday, tuesday, wednesday, thursday, friday, saturday
2.2fromДаНачало рабочего дня: с ... часов
2.3toДаОкончание рабочего дня: до ... часов
2.4startDayShift Нет

Значение 0 или -1, если не задан - считается что текущий день.

-1: предыдущий день

0:  текущий день

2.5endDayShiftНет

Значение 0 или 1 или 2, если не задан - считается что текущий день

0:  текущий день

1: следующий день

2: плюс два дня

3: плюс три дня

4: плюс четыре дня

2.6breakFrom   ДаОбязательный при указании breakTo. Означает - Обед с
2.7breakTo     ДаОбязательный при указании breakFrom. Означает - Обед до
2.8fixedDayStart НетФиксированное начало рабочего дня
3units
Блок со значениями единиц измерений
3.1timeZoneНетТаймзона
3.2timeZoneOffsetДаЧасовой пояс
3.3currencyДаВалюта
3.4distanceUnitsДаЕдиницы измерения расстояния
3.5speedUnitsДаЕдиницы измерения скорости. Значения: METERS_PER_SEC   KILOMETERS_PER_HOUR   MILES_PER_HOUR.
3.6durationUnitsДаЕдиницы измерения погрузки
3.7weightUnitsДаЕдиницы измерения веса
3.8volumeUnitsДаЕдиницы измерения объема
4zone
Блок, в котором указывается территория, на которой может работать водитель
4.1nameНетНазвание территории
5start locationНетБлок информации об адресе начала рабочего дня. Если start location не используются, не заполнять данный блок.
5.1startLocation addressДаАдрес локации
5.2latitudeНетДолгота
5.3longitude НетШирота
6home location
Блок информации об адресе возврата в конце дня. Если home location не используются, не заполнять данный блок.
6.1addressДаАдрес локации
6.2latitudeНетДолгота
6.3longitude НетШирота

Значение полей 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>