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 5 Next »

запрос getAreaOfControls

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


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

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

#

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

Тип

Стиль

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

Описание

1

sessionID

Текст


Да

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

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


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


Заголовки:

URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/getAreaOfControls?sessionID=eca3b9f1afa24988834ceb5c6aafdcbf

Метод: POST

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

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

ответ getAreaOfControls

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

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

#

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

Описание

1

areaOfControlResponse


1.1

aocs


1.1.1

aoc


 

Атрибут “id”

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

 

Атрибут “name”

Название распределительного цента.

 

Атрибут “address”

Адрес распределительного цента.


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

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="2.0">
   <areaOfControlResponse>
      <aocs>
         <aoc id="98" name="DC Bristol" address="Hathaway Gardens,Ealing,London,W13 0DH" />
      </aocs>
   </areaOfControlResponse>
</apiResponse>
  • No labels