Регіони

Регіони

Доступ до регіонів надається всім користувачам, в яких є відповідний дозвіл в особистому кабінеті.
Для отримання інформації про регіони передбачені наступні запити:

Метод 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
  }
}