Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Запрос stop

Данный метод используется для остановки автоматического планирования на определенном распределительном центре (или нескольких РЦ).

Если автоматическое планирование не запущено, ответ будет иметь ошибочный статус. Автоматическое планирование не останавливается немедленно, но результат не будет доступен даже частично.


Входные данные запроса stop

Для остановки автоматического планирования API использует application/x-www-form-urlencoded в качестве допустимого представления запроса (Media Type) и стандартный HTTP-метод POST.

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

#

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

Тип

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

Описание

1

sessionID

Текст

Да

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

2

aocID

Целое число

Нет

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

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

 

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

Заголовки:

URL: /rest/2/distribution-api/schedules/stop?sessionID=ff58060757da43a7b94f2b341fec172e&aocID=190&aocID=91

Метод: POST

Структура: application/x-www-form-urlencoded

Тело запроса: не должно содержать никакой информации

Ответ stop

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


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

 

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

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

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

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

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

Для данного метода шаг планирования не важен.

1.3progressТекущий прогресс шага планирования. Для данного метода не важен..
1.4messageТекст, информирующий о том, что планирование остановлено, либо текст ошибки в случае, если остановить планирование не удалось.

Пример ответа stop

 

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
   <scheduling>
      <requestStatus>true</requestStatus>
      <operationNumber>0</operationNumber>
      <progress>0</progress>
      <message>Scheduler was stopped by user: %username%</message>
   </scheduling>
</apiResponse>
  • No labels