Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

#

Название атрибута

Тип

Обязательный

Описание

1

sessionID

Текст

Да

Идентификатор сессии, полученный от сервера после запроса авторизации.

2

aocID

Целое число

Нет

Список идентификаторов распределительных центров в Максоптре для составления расписания. Если он пуст, будут использоваться все РЦ, доступные текущему пользователю.

3startDateДатаНетДата начала планирования. Эта дата должна быть равна или быть позже текущей даты. Если дата отсутствует, будет использоваться текущая дата. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат - “DD/MM/YYYY”. Для России - “ДД.MM.ГГГГ”.


Пример запроса status

Заголовки:

...

Структура application/xml используется в качестве структуры ответа.

 


Выходные данные ответа status


 

1scheduling
 

1.1requestStatusСтатус процесса планирования. Возможные значения: true/false. Если планирование идет без ошибок, в ответе приходит "true"; если планирование не удалось, в ответе приходит "false".
1.2operationNumber

Шаг планирования. Существуют три шага планирования:

2 - расчет матрицы

1 - идёт планирование

0 - планирование завершено

1.3progressТекущий прогресс шага планирования.
1.4messageТекст, информирующий о том, какое количество заказов запланировано/не запланировано, либо текст ошибки.
#
Название поля
Описание
 



Примеры ответа status

в процессе планирования: 


Code Block
languagexml
<?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
languagexml
<?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>



См. также

Методы API. Автопланирование

Автоматическое планирование

Статусы операций создания, редактирования и удаления заказов