Руководство разработчика
Ресурсы API

Список дочерних регионов

Краткое содержание

Описание

georegion/{geo_id}/children

Возвращает список дочерних регионов указанного в запросе региона. Ресурс является списочным.

В запросе вместо {geo_id} указывается идентификатор региона.

URL ресурса:

https://api.content.market.yandex.ru/v1/georegion/{geo_id}/children.[format]

Входные данные

ПараметрТипЗначение
Необязательные

count

Integer

Количество выводимых результатов на странице ответа.

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

Максимально возможное значение: 30.

page

Integer

Номер страницы результатов, которую необходимо показать в ответе.

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

Максимально возможное значение: 50.

Выходные данные

Структура выходных данных:

<georegions
[no-highlight[

Значение

Список регионов.

]no-highlight]
page
[no-highlight[

Значение

Номер выводимой страницы результатов.

Для формата XML является атрибутом.

]no-highlight]
="{номер_страницы}" total
[no-highlight[

Значение

Общее количество результатов в списке.

Для формата XML является атрибутом.

]no-highlight]
="{количество_результатов}" count
[no-highlight[

Значение

Количество выводимых результатов на странице.

Для формата XML является атрибутом.

]no-highlight]
="{количество_результатов_на_странице}"> <georegion
[no-highlight[

Значение

Описание региона / регионов.

]no-highlight]
name
[no-highlight[

Значение

Название региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{название_региона}" children-count
[no-highlight[

Значение

Количество дочерних регионов.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{количество_регионов}" parent-id
[no-highlight[

Значение

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{идентификатор_региона}" type
[no-highlight[

Значение

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{тип_региона}" id
[no-highlight[

Значение

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{идентификатор_региона}"/> ... </georegions>
{
  "georegions
[no-highlight[

Значение

Список регионов.

]no-highlight]
": { "page
[no-highlight[

Значение

Номер выводимой страницы результатов.

Для формата XML является атрибутом.

]no-highlight]
": {номер_страницы}, "total
[no-highlight[

Значение

Общее количество результатов в списке.

Для формата XML является атрибутом.

]no-highlight]
": {количество_результатов}, "count
[no-highlight[

Значение

Количество выводимых результатов на странице.

Для формата XML является атрибутом.

]no-highlight]
": {количество_результатов_на_странице}, "items
[no-highlight[

Значение

Описание региона / регионов.

]no-highlight]
": [ { "name
[no-highlight[

Значение

Название региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": "{название_региона}", "childrenCount
[no-highlight[

Значение

Количество дочерних регионов.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": {количество_регионов}, "parentId
[no-highlight[

Значение

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": {идентификатор_региона}, "type
[no-highlight[

Значение

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": "{тип_региона}", "id
[no-highlight[

Значение

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
":{идентификатор_региона} }, ... ] } }

Описание параметров:

Параметр для формата XMLПараметр для формата JSONТипЗначение
georegions georegions

Список регионов.

Параметры, вложенные в georegions
page page Integer

Номер выводимой страницы результатов.

Для формата XML является атрибутом.

total total Integer

Общее количество результатов в списке.

Для формата XML является атрибутом.

count count Integer

Количество выводимых результатов на странице.

Для формата XML является атрибутом.

georegion items

Описание региона / регионов.

Параметры, вложенные в georegion/items
name name String

Название региона.

Для формата XML является атрибутом параметра georegion.

children-count childrenCount Число

Количество дочерних регионов.

Для формата XML является атрибутом параметра georegion.

parent-id parentId Число

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

type type Enum

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

id id Число

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

Описания ошибок

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.

Примеры

Пример запроса:

GET https://api.content.market.yandex.ru/v1/georegion/225/children.xml

Пример ответа:

<georegions page="1" total="11" count="10">
  <georegion name="Центр" children-count="19" parent-id="225" type="COUNTRY_DISTRICT" id="3"/>
  <georegion name="Северо-Запад" children-count="12" parent-id="225" type="COUNTRY_DISTRICT" id="17"/>
  <georegion name="Юг" children-count="8" parent-id="225" type="COUNTRY_DISTRICT" id="26"/>
  <georegion name="Северный Кавказ" children-count="9" parent-id="225" type="COUNTRY_DISTRICT" id="102444"/>
  <georegion name="Поволжье" children-count="16" parent-id="225" type="COUNTRY_DISTRICT" id="40"/>
  <georegion name="Урал" children-count="8" parent-id="225" type="COUNTRY_DISTRICT" id="52"/>
  <georegion name="Сибирь" children-count="14" parent-id="225" type="COUNTRY_DISTRICT" id="59"/>
  <georegion name="Дальний Восток" children-count="11" parent-id="225" type="COUNTRY_DISTRICT" id="73"/>
  <georegion name="Крымский федеральный округ" children-count="1" parent-id="225" type="COUNTRY_DISTRICT" id="115092"/>
  <georegion name="Прочее" children-count="0" parent-id="225" type="OTHER" id="381"/>
</georegions>

Пример запроса:

GET https://api.content.market.yandex.ru/v1/georegion/225/children.json

Пример ответа:

{
  "georegions":
  {
    "page": 1,
    "count": 10,
    "total": 11,
    "items":
    [
      {
        "id": 3,
        "name": "Центр",
        "parentId": 225,
        "childrenCount": 19,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 17,
        "name": "Северо-Запад",
        "parentId": 225,
        "childrenCount": 12,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 26,
        "name": "Юг",
        "parentId": 225,
        "childrenCount": 8,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 102444,
        "name": "Северный Кавказ",
        "parentId": 225,
        "childrenCount": 9,
        "type": "COUNTRY_DISTRICT"
       },
       {
        "id": 40,
        "name": "Поволжье",
        "parentId": 225,
        "childrenCount": 16,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 52,
        "name": "Урал",
        "parentId": 225,
        "childrenCount": 8,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 59,
        "name": "Сибирь",
        "parentId": 225,
        "childrenCount": 14,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 73,
        "name": "Дальний Восток",
        "parentId": 225,
        "childrenCount": 11,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 115092,
        "name": "Крымский федеральный округ",
        "parentId": 225,
        "childrenCount": 1,
        "type": "COUNTRY_DISTRICT"
      },
      {
        "id": 381,
        "name": "Прочее",
        "parentId": 225,
        "childrenCount": 0,
        "type": "OTHER"
      }
    ]
  }
}
georegion/{geo_id}/children Регионы