position

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

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

Примечание

Доступна пагинация.

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=position
  & [actionObjectID=<integer>]

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

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

row0

Элемент списка с соответствующим номером.

row0

Элемент списка с соответствующим номером.

ID

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

name

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

isPredefined

Тип объекта.

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

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

dateAdded

Дата добавления расположения.

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

Запрос:

https://adfox.yandex.ru/api/v1?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:

Предыдущая
Следующая