getSchedulingZones

Owned by Former user (Deleted)
Last updated: Jun 16, 2022 by Admin Doc Maxoptra


запрос getSchedulingZones

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

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

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

Примечание. Перед тем как сделать запрос getSchedulingZones, мы рекомендуем вам воспользоваться методом getAreaOfControls для получения из Максоптры актуальных идентификаторов распределительных центров (aocID). Обращаем ваше внимание, что идентификаторы распределительных центров могут изменяться во время миграций с сервера на сервер. В связи с этим мы рекомендуем вам получать идентификатор распределительного центра каждый раз перед запросом getSchedulingZones.

#

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

Тип

Стиль

Обязательность

Описание

1

sessionID

Текст


Да

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

Срок жизни сессии – 5 минут. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут

2

aocID

Целое число

Query

Да

Идентификатор распределительного центра в приложении


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

Заголовки:

Метод: POST

URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/getSchedulingZones?sessionID=94bb1165ed40419dbecde6910fb1bff1&aocID=337

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

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

ответ getSchedulingZones

Для получения списка зон планирования в рамках одного распределительного центра (области контроля) API использует структуру application/xml как структуру ответа.


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

#

Название поля

Описание

1

SchedulingZonesResponse


1.1

zones


1.1.1

zones


 

Атрибут “id”

Идентификатор зоны планирования в аккаунте, который может быть использован в дальнейших вопросах

 

Атрибут “name”

Имя зоны планирования

 

Атрибут “aocId”

Идентификатор распределительного центра, которому принадлежат зоны планирования


Атрибут "aocName"Название распределительного центра

 

Атрибут “area”

Координаты многоугольника который ограничивает зону планирования


Атрибут “color”Цвет зоны планирования


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

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
   <SchedulingZonesResponse>
      <zones>
         <zone id="36" name="Березники" aocId="337" aocName="РЦ Центр" area="59.27149, 56.20605|59.74533, 56.21979|59.83101, 56.85974|59.7564, 57.50519|59.47717, 57.54639|59.19281, 57.48047" color="#808080" />
         <zone id="37" name="Оса" aocId="337" area="56.876, 55.72266|56.96444, 55.20081|57.29834, 55.27496|57.58656, 55.96161" />
         <zone id="42" name="Чусовой" aocId="337" area="58.02119, 58.18634|58.38444, 58.44452|58.52311, 57.90207|58.42185, 57.10693|57.9717, 57.30743" />
         <zone id="43" name="Добрянка" aocId="337" area="58.21558, 56.79657|58.16346, 56.57135|58.16925, 56.37634|58.31382, 56.3324|58.34698, 56.46149|58.4125, 56.44432|58.54604, 56.24176|58.60261, 56.64825" />
      </zones>
   </SchedulingZonesResponse>
</apiResponse>