category

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

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

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

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

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

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

type

Фильтр по типу категории.

Допустимые значения:

  • 0 — постоянные категории;
  • 1 — временные категории.

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>     
     <type>{integer}</type>
     <timeout>{integer}</timeout>
    </row0>
</response>

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

code

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

row0

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

ID

Уникальный идентификатор категории.

name
Название категории.
type

Тип категории.

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

  • 0 — постоянная категория;
  • 1 — временная категория.
timeout

Активность категории в днях.

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

Запрос:

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

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>11419</ID>
     <name>example</name>
     <type>1</type>
     <timeout>23</timeout>
    </row0>
</response>

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

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