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 23 Next »

 запрос importPerformers

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


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

 

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

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

externalId

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

allowDailyDrivingLimit

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

dailyDrivingLimit

Число[1;4320]НетЗначение лимита за смену (указывается в минутах)
1.13

allowDailyWorkingLimit

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

dailyWorkingLimit

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

scheduleZonesId

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

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

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

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

2.5endDayShiftЧисло255Нет

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

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

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

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

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

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