Запрос start
Данный метод используется для запуска автоматического планирования на определенном распределительном центре (или нескольких РЦ).
...
Входные данные должны отправляться как атрибуты и не должны находиться в теле запроса. Список всех поддерживаемых атрибутов представлен ниже.
| # | Название атрибута | Тип | Обязательный | Описание |
|---|---|---|---|---|
| 1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. |
| 2 | aocID | Целое число | Нет | Список идентификаторов распределительных центров в Максоптре для составления расписания. Если он пуст, будут использоваться все РЦ, доступные текущему пользователю. |
| 3 | startDate | Дата | Нет | Дата начала планирования. |
Эта дата должна быть равна или быть позже текущей даты. Если дата отсутствует, будет использоваться текущая дата. Если вы планируете на дату в будущем, ее обязательно нужно указать. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат - “DD/MM/YYYY”. Для России - “ДД.MM.ГГГГ”. | ||||
| 4 | isSchedulingCollections | Логический | Нет | Отметка для разрешения планирования заказов типа «Сбор» |
| 5 | incrementalScheduling | Логический | Нет | Запускает допланирование заказов в зафиксированные, но не начатые рейсы. |
Пример запроса start
Заголовки:
Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/start?sessionID=ff58060757da43a7b94f2b341fec172e&aocID=[190,91]&startDate=20182016-08-26&isSchedulingCollections=falseМетод: POST
Структура: application/x-www-form-urlencoded
...
Структура application/xml используется в качестве структуры ответа.
Данные содержатся внутри объекта Scheduling
requestStatus: логический * - если
Выходные данные ответа start
| # | Название поля | Описание |
|---|---|---|
| 1 | scheduling | |
| 1.1 | requestStatus | Статус процесса планирования. Возможные значения: true/false. Если планирование начато успешно, |
...
| в ответе приходит "true"; если планирование уже было запущено, |
...
operationNumber: целое число – шаг планирования(2 – расчет матрицы, 1 – идет планирование, 0 – планирование завершено). Для метода start не важен
progress: целое число – текущий прогресс шага. Для метода start будет 0
message: текст – текст ошибки, в случае если запустить планирование не удалось
Выходные данные ответа start
| # | Название поля | Описание |
|---|---|---|
| 1 | scheduling | |
| в ответе приходит "false". | ||
| 1.2 | operationNumber | Шаг планирования. Существуют три шага планирования: 2 - расчет матрицы 1 - идёт планирование 0 - планирование завершено Для данного метода шаг планирования не важен. |
| 1.3 | progress | Текущий прогресс шага планирования. Для данного метода актуально значение "0". |
| 1.4 | message | Текст ошибки в случае, если запустить планирование не удалось. |
Пример ответа start
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
<scheduling>
<requestStatus>true</requestStatus>
<operationNumber>2</operationNumber>
<progress>0</progress>
</scheduling>
</apiResponse> |
...
См. также