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

Информация о регионе

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

Описание

georegion/{geo_id}

Возвращает информацию о регионе.

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

URL ресурса:

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

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

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

<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]
="{идентификатор_региона}"/>
{
  "georegion
[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ТипЗначение
georegion georegion

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

Параметры, вложенные в georegion
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.xml

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

<georegion name="Россия" children-count="11" parent-id="10001" type="COUNTRY" id="225"/>

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

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

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

{
  "georegion":
  {
    "id": 225,
    "name": "Россия",
    "parentId": 10001,
    "childrenCount": 11,
    "type": "COUNTRY"
  }
}
georegion/{geo_id} Регионы