Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

 запрос importPerformers

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


/rest/2/distribution-api/objects/importPerformers

 

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

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

externalId

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

allowDailyDrivingLimit

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

dailyDrivingLimit

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

allowDailyWorkingLimit

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

dailyWorkingLimit

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

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: плюс два дня

2.6breakFrom   ДаОбязательный при указании breakTo. Означает - Обед с
2.7breakTo     ДаОбязательный при указании breakFrom. Означает - Обед до
2.8fixedDayStart НетФиксированное начало рабочего дня
3zoneНетБлок, в котором указывается территория, в которой может работать водитель
3.1nameНетНазвание территории
4start locationНетБлок информации об адресе начала рабочего дня. Если start location не используются, не заполнять данный блок.
4.1startLocation addressДаАдрес локации
4.2latitudeНетДолгота
4.3longitude НетШирота
5home locationНетБлок информации об адресе возврата в конце дня. Если home location не используются, не заполнять данный блок.
5.1addressДаАдрес локации
5.2latitudeНетДолгота
5.3longitude НетШирота

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

 

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

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

    <apiRequest>

        <sessionID>6345e0588e384fc4acc3a2e63e9a4d39</sessionID >

              <performersDetails>

<units />

           <performers>                   

           <performer name="Водитель Ивановphone="555-437-82" email="ivanov_magenta_voditel@gmail.com"

           login="Driver_API_3782387121" password="123456" 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="" />

  <homeLocation address="Drake Crescent, Chippenham, Wiltshire, SN14, GB" latitude="51.453891" longitude="-2.148895"/>

                 <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>

<zones>

               <zone name="Center"/>

            </zones>

           </performer>           

          </performers>

        </performersDetails>

       </apiRequest>


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

 

<apiResponse version="1.0">

   <performers>

      <performer>

         <name>Водитель Иванов</name>

         <login>Driver_API_3782387121</login>

      </performer>

   </performers>

</apiResponse>

 

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

 

причина

ошибка

1

При указании некорректного sessionID

1009 - "Provided credentials are invalid"

2

При отсутствии обязательного параметра

1230 - "Parameter is required: %name%", name – имя отсуствующего параметра

3

При некорректном вводе email

1232 - "Invalid value for e-mail: %wrongname%"

4

При вводе некорректных значений

1107 - "Field type is incorrect: %name% = %valuename%. Expected %expectedtype% type"

5

При вводе несуществующего DC

1203 - "Area Of Control was not found"

6

При запросе к DC, на которое у пользователя нет прав

1019 - "User with provided credentials doesn't have AoC access or AoC doesn't exist"

7

При отсутствии одного из полей breakFrom или breakTo, когда одно из них задано

1231 - "Invalid value for break, both values breakFrom and breakTo are required"

8

Пустое значение password при редактировании водителя

1233 - "The value for password is empty"

9Водитель и депо принадлежат разным территориям1217 - Invalid value for scheduleZonesString


  • No labels