Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#

Название атрибута

Тип

Обязательность

Описание

1sessionIDТекстДаИдентификатор сессии, полученный от сервера после запроса авторизации.

2

date

ДатаДаДата, на которую назначен(ы) рейс(ы).
3vehicleExternalIDТекстНетЕсли указан, то отошлются только рейсы, назначенные на данную машину.
4driverExternalIDТекстНетЕсли указан, то отошлются только рейсы, назначенные на данного водителя.
5dcNameТекстНетЕсли указан, то отошлются только рейсы для данного РЦ.
6runNumberЧислоНетЕсли указан, то отошлется только выбранный рейс.

...

В запросе возможны следующие комбинации атрибутов:  

  1. Отправка рейсов для всех РЦ данного аккаунтаsessionID + date; 

  2. Sending runs of a certain DC: sessionID + date + dcName; 

  3. Sending runs of a certain vehicle: sessionID + date + vehicleExternalID; 

  4. Sending runs of a certain driver: sessionID + date + driverExternalID; 

  5. Sending a certain run of a certain vehicle: sessionID + date + vehicleExternalID + runNumber; 

  6. Sending a certain run of a certain driver: sessionID + date + driverExternalID + runNumber.

Примечание Указание сразу нескольких атрибутов приводит к избыточности (кроме случая vehicleExternalI/driverExternalID + runNumber), и система отреагирует на это ошибкой (1020 "Redundant parameters" - Избыточные параметры). См. перечень возможных ошибок ниже.

...

Ошибка

Описание

Описание
1009Invalid or unknown session IDНедействительный или неизвестный идентификатор сессии
1013Date in incorrect formatНекорректный формат даты
1014Expected parameter not providedОжидаемый параметр не представлен
1015Internal service errorВнутренняя ошибка
1020Redundant parametersИзбыточные параметры
1202Area of control is not foundНе найдены распределительные центры
1206Performer is not foundВодитель не найден
1304Vehicle is not foundМашина не найдена


Пример ошибки 

<?xml versionxml version='"1.0' encoding='" encoding="UTF-8' standalone='yes'" standalone="yes"?>
<apiResponse version="1.0">
<error>
<errorCode>1015</errorCode>
<errorMessage>
<![CDATA["Internal Service Error"]]>
</errorMessage>
</error>

<apiResponse>
    <errors>
        <error>
            <errorCode>1020</errorCode>
            <errorMessage>Incorrect parameters: If dcName is specified, no vehicleExternalID or driverExternalID is expected</errorMessage>
        </error>
    </errors>
</apiResponse>