Page Comparison

...

...

...

...

...

...

запрос importPerformers

Запрос используется для импорта водителей (Performers) в систему. Для импорта водителей по API используется структура application/xml и HTTP-метод POST.

URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/importPerformers

Все возможные атрибуты для performer:

• externalId
• login (обязательный – по нему ищем водителя при апдейте)
• password  (обязательный для нового водителя)
• name (обязательный)
• email (обязательный)
• phone
• comments
• priceForOneHour (обязательный)
• breakShift (обязательный только если включены фиксированные обеды)
• areaOfControl (обязательный)
• allowDailyDrivingLimit
• dailyDrivingLimit
• allowDailyWorkingLimit
• dailyWorkingLimit
• scheduleZonesId

Все возможные атрибуты для availability:

...

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

...

Значения для startDayShift и endDayShift:

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

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

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

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

Значение полей dailyDrivingLimit и dailyDrivingLimit имеют смысл только при наличии включенных полей allowDailyDrivingLimit и allowDailyWorkingLimit соответственно.

...

...

• name – имя локации
• address – адрес локации
• latitude - долгота
• longitude - широта

Возможные ошибки:

Метод importPerformers ищет по логину водителя. Если логин найден, то содержание всех полей обновляется. Если нет, то в системе создается новый водитель.

Значение полей dailyDrivingLimit и dailyDrivingLimit имеют смысл только при наличии включенных полей allowDailyDrivingLimit и allowDailyWorkingLimit соответственно

Пример (перечислены все доступные поля):

<?xml version="1.0" encoding="UTF-8"

...

?>

...

    <apiRequest>

        <sessionID>6345e0588e384fc4acc3a2e63e9a4d39</sessionID >

              <performersDetails>

      <units timeZone="Greenwich Mean Time" timeZoneOffset="GMT+0:00" currency="POUND" distanceUnits="MILE" speedUnits="MILES_PER_HOUR" durationUnits="MINUTE" weightUnits="Kg" volumeUnits="m3"/>

           <performers>                   

           <performer name="Driver_API_3782387" phone="00000" email="Driver_API_3782387@gmail.com"

...

<apiRequest>
   <sessionID>6345e0588e384fc4acc3a2e63e9a4d39</sessionID>
   <performersDetails>
      <units />
      <performers>
         <performer name="Водитель Иванов" phone="555-437-82" email="ivanov_magenta_voditel@gmail.com" login="Driver_API_3782387121" password="

...

12345678" comments="

...

Высокий, носит очки." priceForOneHour="10.5" breakShift="30"

...

 dailyDrivingLimit="720" allowDailyDrivingLimit="1"

...

 dailyWorkingLimit="720" allowDailyWorkingLimit="1"

...

 areaOfControl="chippenhamzone" scheduleZonesId="71"

...

 externalId="

...

1234567890qwerty">
            <startLocation address="10 Bishops Park Road, London, SW6 6DZ" latitude="" longitude="" onlyWithDeliveries="false" />
            <homeLocation address="Drake Crescent, Chippenham, Wiltshire, SN14, GB" latitude="51.453891" longitude="-2.148895" onlyWithCollections="true"/>

...

                 <availabilities>

...

            <availabilities>
               <availability weekDay="monday" from="05:00" to="19:00" breakFrom="10:00" endDayShift="0" breakTo="10:45" />

...

               <availability weekDay="thursday" from="04:30" to="19:00" breakFrom="10:00" breakTo="10:45" />

...

               <availability weekDay="friday" from="06:30" to="19:00" breakFrom="10:00" breakTo="10:45" />

...

               <availability weekDay="saturday" from="05:00" to="19:00" breakFrom="10:00" breakTo="10:45" />

...

               <availability weekDay="sunday" from="05:00" to="19:00" breakFrom="10:00" breakTo="10:45" />

...

               </availabilities>

           </performer>           

          </performers>

        </performersDetails>

       </apiRequest>

Ответ, если все прошло хорошо:

...

            </availabilities>
            <zones>
               <zone name="Center" />
            </zones>
         </performer>
      </performers>
   </performersDetails>
</apiRequest>

Ответ при успешном импорте:

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">

...

   <performers>

      <performer>

         <name>Driver_API_3782387</name>

         <login>Driver_API_3782387121</login>

      </performer>

   </performers>

</apiResponse>

Экспорт водителей

rest/2/distribution-api/objects/exportPerformers

Содержит параметр sessionID

 rest/2/distribution-api/objects/exportPerformers?sessionID=a5fad852a18149468d1b9845bbd8e1a8

Возвращает ответ

<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="Andy Marey" externalId="2675d0e99a1047e6bd0ebafc326bb939" email="andy@magenta.com" login="andy" passwordHash="42767516990368493138776584305024125808" maxWorkingHours="40" allowedOvertimePerWeek="0" priceForOneHour="0" dailyDrivingLimit="480" allowDailyDrivingLimit="false" dailyWorkingLimit="660" allowDailyWorkingLimit="false" breakShift="0" areaOfControl="FrogwellZone">

            <homeLocation name="Frogwell" 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>

      <performersDetails>

...

   <performers>
      <performer>
         <name>Водитель Иванов</name>
         <login>Driver_API_3782387121</login>
      </performer>
   </performers>
</apiResponse>

Возможные ошибки: