geobaseTree
Получить справочник по географии.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=account
& action=utility
& actionObject=geobaseTree
& [hideChildren=<integer>]
& [regionID=<integer>]
|
Отображать дочерние элементы регионов. Допустимые значения:
Значение по умолчанию: |
|
Начальный узел дерева. С его дочерних объектов начинается вывод дерева. Значение по умолчанию: |
* Обязательный параметр
Формат ответа
<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>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве. |
|
Порядковый номер элемента в дереве, где N — число от 0 до rows-1. |
|
id региона. |
|
Название страны. |
|
Данный элемент имеет дочерние регионы, внутри тега будет идти перечисление дочерних регионов (выводится при параметре hideChildren=0). |
|
Данный элемент имеет дочерние регионы, внутри тега выведено число дочерних регионов (выводится при параметре hideChildren=1). |
Пример запроса и ответа
Полный ответКороткий ответЗапрос:
https://adfox.yandex.ru/api/v1?object=account&action=utility&actionObject=geobaseTree®ionID=225
Ответ:
<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://adfox.yandex.ru/api/v1?object=account&action=utility&actionObject=geobaseTree®ionID=225
Ответ:
<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://adfox.yandex.ru/api/v1?object=account&action=utility&actionObject=geobaseTree&hideChildren=1®ionID=10000
Ответ:
<response> <status> <code>0</code> </status> <result> <rows>8</rows> <data> <row0> <id>138</id> <name_ru>Австралия и Океания</name_ru> <children_count>2</children_count> </row0> <row1> <id>183</id> <name_ru>Азия</name_ru> <children_count>8</children_count> </row1> <row2>...</row2> <row3>...</row3> ... <row7>...</row7> </data> </result> </response>
Отображать дочерние элементы регионов.
Допустимые значения:
-
0
— полный ответ, при котором показаны дочерние элементы; -
1
— краткий ответ, при котором скрыты дочерние элементы, но в полеchildren_count
выведено их число.
Значение по умолчанию: 0
.
Начальный узел дерева. С его дочерних объектов начинается вывод дерева.
Значение по умолчанию: 10000
— «Весь мир».
Обязательный параметр