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

Описание

GET /regions/{regionId}/children

Возвращает информацию о регионах, являющихся дочерними по отношению к региону, идентификатор которого указан в запросе.

Примечание. Метод доступен начиная с версии 2.3 партнерского API Яндекс.Маркета.

URL ресурса:

https://api.partner.market.yandex.ru/v2/regions/{regionId}/children.[format]

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

Параметр

Тип

Значение

Обязательные

regionId

Int64

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

Идентификатор региона можно получить c помощью запроса GET /regions.

Необязательные

page

Int32

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

Если указан номер страницы, превышающий общее количество найденных страниц, выдаются результаты по последней странице.

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

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

pageSize

Int32

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

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

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

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

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <pager current-page="{int32}" from="{int32}" pages-count="{int32}" page-size="{int32}" to="{int32}" total="{int32}"/>
  <regions>
    <region id="{int64}" name="{string}" type="{enum}">
      <children>
        <region id="{int64}" name="{string}" type="{enum}"/>
        ...
      </children>
      <parent id="{int64}" name="{string}" type="{enum}">
        ...
      </parent>
    </region>
  </regions>
</response>

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

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

pager pager

Сводка по результатам поиска.

regions regions

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

Параметры, вложенные в pager

current-page currentPage Int32

Порядковый номер текущей страницы результатов.

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

from from Int32

Порядковый номер первой записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

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

pages-count pagesCount Int32

Количество страниц с результатами поиска.

Значение может увеличиваться по мере увеличения номера страницы. Конечное количество страниц будет достигнуто, когда значение параметра pages-count будет равно значению параметра current-page.

Если ничего не найдено, значение параметра: 0.

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

page-size pageSize Int32

Количество записей на текущей странице.

Если ничего не найдено, значение параметра: 0.

До версии 2.0 партнерского API Яндекс.Маркета параметр назывался page-offers.

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

to to Int32

Порядковый номер последней записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

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

total total Int32

Количество найденных записей.

Значение может увеличиваться по мере увеличения номера страницы. Конечное количество найденных записей будет достигнуто, когда значение параметра total будет равно значению параметра to.

Если ничего не найдено, значение параметра: 0.

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

Параметры, вложенные в regions

region

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

Параметр выводится только для формата XML.

Параметры, вложенные в region / regions

id id Int64

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

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

name name String

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

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

type type Enum

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

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

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

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

children children

Дочерние регионы.

parent parent

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

Указываются родительские регионы до уровня страны.

Параметры, вложенные в children

region

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

Параметры, вложенные в region / children

id id Int64

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

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

name name String

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

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

type type Enum

Тип дочернего региона.

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

  • AREA — область;

  • CITY — крупный город;

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

  • COUNTRY — страна;

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

  • MONORAIL_STATION — станция монорельса;

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.);

  • REGION — регион;

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

  • REPUBLIC_AREA — район субъекта федерации;

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.);

  • SETTLEMENT — поселение;

  • SUBURB — пригород;

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

  • TOWN — город;

  • UNKNOWN — неизвестный регион.

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

Параметры, вложенные в parent

id id Int64

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

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

name name String

Название родительского региона.

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

type type Enum

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

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

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

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

parent parent

Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.

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

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

Page number is too big: 'pageNum'. Max page number is 'maxPageNum'

Указан слишком большой номер страницы.

Проверьте корректность передаваемого номера страницы.

Page number must be positive: 'page'

Номер страницы должен быть положительным числом.

Проверьте корректность передаваемого номера страницы.

Page size is too big: 'pageSize'. Max page size is 'maxPageSize'

Указан слишком большой размер страницы.

Проверьте корректность передаваемого размера страницы.

Page size must be positive: 'pageSize'

Размер страницы должен быть положительным числом.

Проверьте корректность передаваемого размера страницы.

Ошибка 404 Not Found

Region not found: 'regionId'

Регион с идентификатором regionId не найден.

Проверьте корректность идентификатора региона.

Ограничения

Для методов GET /regions, GET /regions/{regionId} и GET /regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

Объем запросов к ресурсу, который возможно выполнить в течение суток, зависит от суммарного количества регионов.

Примеры

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

curl -i -H 'Content-Type: application/xml' 'https://api.partner.market.yandex.ru/v2/regions/1/children.xml?page=2&pageSize=20'

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

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <pager current-page="2" from="21" pages-count="4" page-size="20" to="40" total="75"/>
  <regions>
    <region id="1" name="Москва и Московская область" type="REPUBLIC">
      <children>
        <region id="98580" name="Волоколамский район" type="REPUBLIC_AREA"/>
        <region id="98581" name="Воскресенский район" type="REPUBLIC_AREA"/>
        <region id="98582" name="Дмитровский район" type="REPUBLIC_AREA"/>
        <region id="98589" name="Коломенский район" type="REPUBLIC_AREA"/>
        <region id="98592" name="Лотошинский район" type="REPUBLIC_AREA"/>
        <region id="98593" name="Луховицкий район" type="REPUBLIC_AREA"/>
        <region id="98594" name="Люберецкий район" type="REPUBLIC_AREA"/>
        <region id="98595" name="Можайский район" type="REPUBLIC_AREA"/>
        <region id="98596" name="Мытищинский район" type="REPUBLIC_AREA"/>
        <region id="98597" name="Наро-Фоминский район" type="REPUBLIC_AREA"/>
        <region id="98598" name="Ногинский район" type="REPUBLIC_AREA"/>
        <region id="98599" name="Одинцовский район" type="REPUBLIC_AREA"/>
        <region id="98600" name="Озерский район" type="REPUBLIC_AREA"/>
        <region id="98601" name="Орехово-Зуевский район" type="REPUBLIC_AREA"/>
        <region id="98602" name="Павлово-Посадский район" type="REPUBLIC_AREA"/>
        <region id="98603" name="Подольский район" type="REPUBLIC_AREA"/>
        <region id="98604" name="Пушкинский район" type="REPUBLIC_AREA"/>
        <region id="98605" name="Раменский район" type="REPUBLIC_AREA"/>
        <region id="98606" name="Рузский район" type="REPUBLIC_AREA"/>
        <region id="98607" name="Ступинский район" type="REPUBLIC_AREA"/>
      </children>
      <parent id="3" name="Центральный федеральный округ" type="AREA">
        <parent id="225" name="Россия" type="COUNTRY"/>
      </parent>
    </region>
  </regions>
</response>