Регионы

Метод list позволяет получить список регионов

Запрос:

{site_path}/{lang}/api/region/list

Список GET параметров:

filter	array	Позволяет фильтровать данные по всем доступным полям
fields	string	Позволяет выбрать из всех доступных только указанные поля
sort	string	Позволяет сортировать по возрастанию и по убыванию сущности по всем доступным полям
page	int	Позволяет передать порядковый номер страницы списка сущностей

Список всех доступных полей

id	int	ID региона
countryID	int	ID страны
name	string	Название региона
r2	string	Международный код региона (R2)

Ответ

Ответ передается в формате JSON. Список полей ответа:

result	array	Список регионов с учетом параметров запроса
_links	array	Список ссылок навигации. Может содержать элементы: self - содержит ссылку на текущую страницу списка first - содержит ссылку на первую страницу списка last - содержит ссылку на последнюю страницу списка prev - содержит ссылку на предыдущую страницу списка next - содержит ссылку на следующую страницу списка
_meta	array	Информация по навигации списка. Содержит элементы: totalCount - общееколичество доступных сущностей учитывая все выбранные параметры pageCount - порядковый номер сущности в полученном списке, с которого начинается текущая страница currentPage - порядковый номер текущей страницы perPage - количество сущностей отображаемых на одной странице

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

{site_path}/{lang}/api/region/list?filter[id][in][]=1&filter[id][in][]=2&filter[id][in][]=3&sort=name

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

{
  "result": [
    {
      "id": 2,
      "countryID": 145,
      "name": "Bakool",
      "r2": "BK"
    },
    {
      "id": 3,
      "countryID": 145,
      "name": "Banaadir",
      "r2": "BN"
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/region/list?%3Ffilter%5Bid%5D%5Bin%5D%5B0%5D=1&filter%5Bid%5D%5Bin%5D%5B0%5D=2&filter%5Bid%5D%5Bin%5D%5B1%5D=3&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}