Запрос status
Данный метод используется для запроса статусов о запущенных сессиях сессий автоматического планирования для определенного распределительного центра (или нескольких РЦ).
...
Входные данные должны отправляться как атрибуты и не должны находиться в теле запроса. Список всех поддерживаемых атрибутов представлен ниже.
| # | Название атрибута | Тип | Обязательный | Описание |
|---|---|---|---|---|
| 1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. |
| 2 | aocID | Целое число | Нет | Список идентификаторов распределительных центров в Максоптре для |
поиска информации о статусах. Укажите идентификаторы тех РЦ, по которым вы хотите получить информацию. Если вам нужна информация по всем РЦ, укажите идентификаторы всех РЦ, имеющихся на данном аккаунте. | ||||
| 3 | startDate | Дата | Нет | Дата начала планирования. Эта дата должна быть равна или быть позже текущей даты. Если дата отсутствует, будет использоваться текущая дата. Если вы планируете на дату в будущем, ее обязательно нужно указать. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат - “DD/MM/YYYY”. Для России - “ДД.MM.ГГГГ”. |
Пример запроса status
Заголовки:
Метод: GET
URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/status?sessionID=ff58060757da43a7b94f2b341fec172e&aocID=[190,91]
Метод: GET
&aocID=91&startDate=09/04/2019
Тело запроса: не должно содержать никакой информации
...
Структура application/xml используется в качестве структуры ответа.
Выходные данные ответа status
| 1 | scheduling |
| 1.1 | requestStatus | Статус процесса планирования. Возможные значения: true/false. Если планирование идет без ошибок, в ответе приходит "true"; если планирование не удалось, в ответе приходит "false". |
| 1.2 | operationNumber | Шаг планирования. Существуют три шага планирования: 2 - расчет матрицы 1 - идёт планирование 0 - планирование завершено |
| 1.3 | progress | Текущий прогресс шага планирования. |
| 1.4 | message | Текст, информирующий о том, какое количество заказов запланировано/не запланировано, либо текст ошибки. |
# | Название поля | Описание |
|---|
Примеры ответа status
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
<scheduling>
<requestStatus>true</requestStatus>
<operationNumber>1</operationNumber>
<progress>100</progress>
<message />
</scheduling>
</apiResponse> |
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
<scheduling>
<requestStatus>true</requestStatus>
<operationNumber>0</operationNumber>
<progress>100</progress>
<message>Planned successfully 5, not planned 3</message>
</scheduling>
</apiResponse> |
См. также
Статусы операций создания, редактирования и удаления заказов