lock/Unlock request
This request is used to lock schedules to the system. To do it, API uses application/xml as its acceptable request representation, and the standard запрос lockUnlock
Данный запрос был создан для поддержания функциональности автоматического допланирования заказов, начиная с версии Максоптры 5.2.
Для фиксации/расфиксации рейсов в системе API использует структуру application/xml и стандартный HTTP-method POST.
URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/lock
[account-name].maxoptra.com/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
...
Description
...
Входные данные для запроса lockUnlock
Список всех поддерживаемых атрибутов и их описание представлены ниже
...
# | Название атрибута | Тип | Стиль | Обязательность | Описание |
| 1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. | |
| 2 | date | Дата | Query | Да | 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” |
| 23 | vehicleIDLong | Целое число | Query | Yes | ID of the vehicle in Maxoptra |
| 3 | aocID | Long | 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 (идентификатор машины в Максоптре) можно также использовать атрибут vehicle (идентификатор машины во внешней системе) | ||||
| 4 | aocID | Целое число | Query | Да | Идентификатор распределительного центра в Максоптре |
| 5 | runNumber | Целое число | Query | Нет | Идентификатор поездки указанной машины |
Возможны следующие комбинации атрибутов для фиксации/расфиксации расписаний:
- Фиксация по номеру рейса: 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
URL: Примечание
- Расфиксация возможна только в том случае, если детали заказа не были отправлены водителю. При попытке расфиксации начатого рейса - ошибка 1314 (см. ниже).
- Если в запросе помимо vehicleID (vehicle) указать атрибут aocID, то будут зафиксированы все неначатые рейсы по всем машинам этого РЦ.
Пример запроса lockUnlock
URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/{lock|unlock}?date=18.10.2018&{vehicleID=123|aocID=123}&(runNumber=1)
Method: POST
getVehicleLocationByVehicleId response
Lock schedule
...
?sessionID=f16f74a3418e4709bc63a1e503559409&date=28/11/2018&vehicleID=37455&runNumber=1
Ответ lockUnlock
| Code Block |
|---|
<?xml version='1.0' |
...
encoding='UTF-8' |
...
standalone='yes'?> |
...
<apiResponse version="1.0"> |
...
<runLockUnlockResponse> <status>LOCK_SUCCESSFUL</status> |
...
</runLockUnlockResponse> |
...
</apiResponse> |
Unlock schedule
|
Possible errors
...
Error
...
Description
...
...
Возможные ошибки
Ошибка | Описание |
|---|---|
| 1014 | Ожидаемый параметр |
| 1015 | Внутренняя ошибка |
| 1019 | Пользователь не имеет прав доступа для работы с данным распределительным центром или распределительны центр не существует |
| 1314 | Не удалось зафиксировать/расфиксировать рейс |
...
См. также
Автоматическое допланирование заказов