Page Comparison

запрос lock/Unlock requestThis request is used to lock schedules to the system. To do it, API uses application/xml as its acceptable request representation, and the standard unlock

Для фиксации/расфиксации рейсов в системе API использует структуру application/xml и стандартный HTTP-method POST.

URL: /rest/2/distribution-api/schedules/lock

/rest/2/distribution-api/schedules/unlock

Input for Входные данные для запроса lock/Unlock request

The list of all supported attributes and their description provided in the table below.

...

#

...

Attribute name

...

Type

...

Style

...

Mandatory

...

unlock

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

...

#	Название атрибута	Тип	Стиль	Обязательность	Описание
1	date	StringДата	Query	YesДа	Date when the run is scheduled. Depends on the configuration for particular account localization. Example of English format is “DD/MM/YYYY”. Example of Russian format is “DD.MM.YYYY”
2	vehicleIDLong	Целое число	Query	Да	Yes	ID of the vehicle in Maxoptra Идентификатор машины Примечание Вместо атрибута vehicleID (идентификатор машины в Максоптре) можно также использовать атрибут vehicle (идентификатор машины во внешней системе)
3	aocIDLong	Целое число	Query	Yes	ID of the distribution center in MaxoptraДа	Идентификатор распределительного центра в Максоптре
4	runNumber	ShortЦелое число	Query	No	ID of run for particular vehicle in Maxoptra

The following combinations of attributes are possible for run locking/unlocking:

...

Нет	Идентификатор поездки указанной машины

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

Фиксация по номеру рейса: vehicleID + date + runNumberLocking
for the selected vehicleФиксация по номеру машин(ы): vehicleID + date
Locking for the depotФиксация по номеру РЦ: aocID + date

Note

The vehicle attribute (= vehicle's external ID) can be used instead of vehicleID (= vehicle's internal ID).
Locking/unlocking is possible only if the details have not been sent yet. When trying to lock/unlock the started run - error 1314.
When using the aocID attribute together with vehicleID, then all the runs for all the vehicles of the specified depot (AOC) will be locked/unlocked (if details were not sent yet).
It is possible to put multiple vehicles or dates in one request.

Example of getScheduleByVehicleOnDate requestПримечание

Расфиксация возможна только в том случае, если детали заказа не были отправлены водителю. При попытке расфиксации начатого рейса - ошибка 1314 (см. ниже).
Если в запросе помимо vehicleID (vehicle) указать атрибут aocID, то будут зафиксированы все неначатые рейсы по всем машинам этого РЦ.
В одном запросе можно указывать несколько дат и машин.

Пример запроса lock/unlock

URL: /rest/2/distribution-api/schedules/{lock|unlock}?date=18.10.2018&{vehicleID=123|aocID=123}&(runNumber=1)

MethodМетод: POST

getVehicleLocationByVehicleId response

Lock schedule

Ответ lock/unlock

Фиксация рейса

Code Block
<?xml version=

...

"1.0

...

" encoding=

...

"UTF-8

...

" standalone=

...

"yes

...

Unlock schedule

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<apiResponse version="1.0">
    <runLockUnlockResponse>
        <status>UNLOCK_SUCCESSFUL</status>
    </runLockUnlockResponse>
</apiResponse>

Possible errors

...

Error

...

Description

...

" ?>
<apiResponse>
    <runs>
        <run>
            <number>1</number>
            <status>LOCKED</status>
            <date>1531612800000</date>
            <vehicleId>986</vehicleId>
            <stops />
        </run>
        <run>
            <number>1</number>
            <status>LOCKED</status>
            <date>1531612800000</date>
            <vehicleId>9870</vehicleId>
            <stops />
        </run>
    </runs>
</apiResponse>

Расфиксация рейса

Code Block

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<apiResponse>
    <runs>
        <run>
            <number>1</number>
            <status>UNLOCKED</status>
            <date>1531612800000</date>
            <vehicleId>986</vehicleId>
            <stops />
        </run>
        <run>
            <number>1</number>
            <status>UNLOCKED</status>
            <date>1531612800000</date>
            <vehicleId>9870</vehicleId>
            <stops />
        </run>
    </runs>
</apiResponse>

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

Ошибка	Описание
1014	Ожидаемый параметр
1015	Внутренняя ошибка
1019	Пользователь не имеет прав доступа для работы с данным распределительным центром или распределительны центр не существует
1314	Не удалось зафиксировать/расфиксировать

Versions Compared

Old Version 4

New Version 5

Key

Ответ lock/unlock