Структура ответа#

Детальное описание структуры ответа от /api/dictionary/cities.

Основная структура#

Тело ответа — массив верхнего уровня City[] (может быть пустым []), отсортированный по id по возрастанию.

Структура City#

Поле	Тип	Обязательно	Описание
`id`	integer	Да	Идентификатор города
`nameRu`	string	Да	Название города на русском языке
`nameEn`	string	Да	Название города на английском языке
`latitude`	decimal	Да	Широта
`longitude`	decimal	Да	Долгота
`country`	Country	Да	Страна расположения города

IATA-код города в ответе не возвращается — источник его не предоставляет без отдельного подзапроса на каждый город.

Структура Country#

Поле	Тип	Обязательно	Описание
`id`	integer	Да	Идентификатор страны
`nameRu`	string	Да	Название страны на русском языке
`nameEn`	string	Да	Название страны на английском языке

Примеры ответов#

Успешный ответ#

 1[
 2  {
 3    "id": 1,
 4    "nameRu": "Москва",
 5    "nameEn": "Moscow",
 6    "latitude": 55.7558,
 7    "longitude": 37.6173,
 8    "country": { "id": 1, "nameRu": "Россия", "nameEn": "Russia" }
 9  }
10]

Пустой справочник (несуществующий или нулевой countryId)#

1[]

Ответ с ошибкой#

1{
2  "code": "BAD_REQUEST",
3  "message": "countryId is required and must be a number"
4}