position

Получить список расположений.

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

Формат запроса

Примечание. Доступна пагинация.
https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=list
 & actionObject=position
 & [actionObjectID=<integer>]
Query-параметры
actionObjectID

Чтобы получить данные только по одному расположению, укажите его идентификатор.

Значение по умолчанию: 0 — выводить список всех расположений.

*  Обязательный параметр

Формат ответа

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <isPredefined>{integer}</isPredefined>
     <dateAdded>{date}</dateAdded>
    </row0>
</response>

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

rows

Количество элементов в дереве ответа.

rowN

Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе).

ID

Уникальный идентификатор расположения.

name
Название расположения.
isPredefined

Тип объекта.

Возможные значения:

  • 0 — пользовательский;
  • 1 — системный.
dateAdded

Дата добавления.

Пример запроса и ответа

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=position

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>6</ID>
     <name><верх страницы></name>
     <isPredefined>1</isPredefined>
     <dateAdded>2005-08-25</dateAdded>
    </row0>
</response>

Другие действия с объектом

См. также другие действия с объектом position: