geobaseTree

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

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=utility
 & actionObject=geobaseTree
 & [hideChildren=<integer>]
 & [regionID=<integer>]
Query-параметры
hideChildren

Отображать дочерние элементы регионов.

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

  • 0— полный ответ, при котором показаны дочерние элементы;
  • 1— краткий ответ, при котором скрыты дочерние элементы, но в поле children_count выведено их число.

Значение по умолчанию: 0.

regionID

Начальный узел дерева. С его дочерних объектов начинается вывод дерева.

Значение по умолчанию: 10000«Весь мир».

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

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

<response>
 <status>
  <code>{integer}</code>
 </status>
 <result>
  <rows>{integer}</rows>
  <data>
   <rowN>
    <id>{integer}</id>
    <name_ru>{string}<name_ru/>
    <children_count>{integer}</children_count>
   </rowN>
   <rowN>
    <id>{integer}</id>
    <name_ru>{string}</name_ru>
    <children_count>{integer}</children_count>
   </rowN>
   <rowN>...</rowN>
   <rowN>...</rowN>
   ...
   <rowN>...</rowN>
  </data>
 </result>
</response>

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

code

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

rows

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

rowN

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

id

id региона.

name_ru

Название страны.

children

Данный элемент имеет дочерние регионы, внутри тега будет идти перечисление дочерних регионов (выводится при параметре hideChildren=0).

children_count

Данный элемент имеет дочерние регионы, внутри тега выведено число дочерних регионов (выводится при параметре hideChildren=1).

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

Запрос:

https://api.adfox.ru/API.php?object=account&action=utility&actionObject=geobaseTree&regionID=225&loginAccount=*&loginPassword=**

Ответ:

<response>
            <status>
            <code>0</code>
            </status>
            <result>
            <rows>9</rows>
            <data>
            <row0>
            <id>3</id>
            <name>Центральный федеральный округ</name>
            <children>
            <row0>
            <id>1</id>
            <name>Москва и Московская область</name>
            <children>
            <row0>
            <id>213</id>
            <name>Москва</name>
            <children/>
            </row0>
            </children>
            </row0>
            <row1>...</row1>
            <row2>...</row2>
            </children>
            </row0>
            <row1>...</row1>
            <row2>...</row2>
            ...
            <row8>...</row8>
            </data>
            </result>
            </response>

Запрос:

https://api.adfox.ru/API.php?object=account&action=utility&actionObject=geobaseTree&regionID=225&loginAccount=*&loginPassword=**

Ответ:

<response>
            <status>
            <code>0</code>
            </status>
            <result>
            <rows>9</rows>
            <data>
            <row0>
            <id>3</id>
            <name>Центральный федеральный округ</name>
            <children>
            <row0>
            <id>1</id>
            <name>Москва и Московская область</name>
            <children>
            <row0>
            <id>213</id>
            <name>Москва</name>
            <children/>
            </row0>
            </children>
            </row0>
            <row1>...</row1>
            <row2>...</row2>
            </children>
            </row0>
            <row1>...</row1>
            <row2>...</row2>
            ...
            <row8>...</row8>
            </data>
            </result>
            </response>