запрос 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
...
# | Название атрибута | Тип | Стиль | Обязательность | Описание |
| 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” |
| 3 | vehicleID | Целое число | Query | Да | Идентификатор машины в Максоптре Примечание Вместо атрибута vehicleID (идентификатор машины в Максоптре) можно также использовать атрибут vehicle (идентификатор машины во внешней системе) |
| 4 | aocID | Целое число | Query | Да | Идентификатор распределительного центра в Максоптре |
| 5 | runNumber | Целое число | Query | Нет | Идентификатор поездки указанной машины |
...
Пример запроса lockUnlock
URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/{lock|unlock}?date=18.10.2018&{vehicleID=123|aocID=123}&(runNumber=1)Метод: POST?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> |
...
Ошибка | Описание |
|---|---|
| 1014 | Ожидаемый параметр |
| 1015 | Внутренняя ошибка |
| 1019 | Пользователь не имеет прав доступа для работы с данным распределительным центром или распределительны центр не существует |
| 1314 | Не удалось зафиксировать/расфиксировать рейс |
...
См. также
Автоматическое допланирование заказов