Міста
Доступ до міст надається всім користувачам, в яких є відповідний дозвіл в особистому кабінеті.
Для отримання інформації про міста передбачені наступні запити:
Метод list дозволяє отримати список міст
Запит:
{site_path}/{lang}/api/city/list
Список GET параметрів:
filter | array | Дозволяє фільтрувати дані по всіх доступних полях |
fields | string | Дозволяє обрати з усіх доступних тільки вказані поля |
sort | string | Дозволяє сортувати у порядку зростання або зменшення сутності по всіх доступних полях |
page | int | Дозволяє передати порядковий номар сторінки списка сутностей |
Список всіх доступних полів
id | int | ID міста |
name | string | Назва міста |
countryID | int | ID країни |
regionID | int | ID регіону |
Відповідь
Відповідь передається у форматі JSON. Список полів відповіді:
result | array | Список міст з урахуванням параметрів запиту |
_links | array | Список посилань навігації. Може містити елементи:
|
_meta | array | Інформація по навігації списку. Містить елементи:
|
Приклад запиту:
{site_path}/{lang}/api/city/list?filter[id][in][]=1&filter[id][in][]=2&filter[id][in][]=3&sort=name
Приклад відповіді:
{ "result": [ { "id": 18918, "name": "Protaras", "countryID": 34, "regionID": 88 }, { "id": 32767, "name": "Qarc", "countryID": 28, "regionID": 59 }, { "id": 5819, "name": "Souni", "countryID": 34, "regionID": 1 } ], "_links": { "self": { "href": "{site_path}/{lang}/api/city/list?filter%5Bid%5D%5Bin%5D%5B0%5D=5819&filter%5Bid%5D%5Bin%5D%5B1%5D=18918&filter%5Bid%5D%5Bin%5D%5B2%5D=32767&sort=name&page=1" } }, "_meta": { "totalCount": 3, "pageCount": 1, "currentPage": 1, "perPage": 20 } }