Возвращает список городов

Request

GET

/cities

Query parameters

Name

Description

cityId

Type: string[]

Идентификатор города в базе данных.

limit

Type: string<int64>

Количество элементов в ответе.

offset

Type: string<int64>

Смещение первого элемента списка относительно его начала.
Например, при значении "offset 5" список будет начинаться с шестого элемента.

updatedAfter

Type: string<date-time>

События, обновленные после этого времени попадут в ответ.
Заполняется в формате UNIX времени.
Если поле заполнено, пагинация не работает.

Responses

200 OK

OK

Body

application/json
{
    "cities": [
        {
            "id": "string",
            "name": "string",
            "coordinates": {
                "latitude": 0,
                "longitude": 0
            },
            "timezone": "string",
            "integrations": [
                {
                    "serviceId": "string",
                    "sourceId": "string"
                }
            ],
            "additional": {}
        }
    ],
    "paging": {
        "limit": "string",
        "offset": "string",
        "total": "string"
    }
}

Name

Description

cities

Type: City[]

Список городов.

paging

Type: ListInfo

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

City

Name

Description

id*

Type: string

Идентификатор города в базе данных.

name*

Type: string

Название города в базе данных.

additional

Type: object

Служебное поле.

coordinates

Type: Coordinates

Координаты города.

integrations

Type: SourceRef[]

Поле для внутреннего использования.

timezone

Type: string

Временная зона, в формате tz database. Например: Europe/Moscow, Asia/Yekaterinburg.

ListInfo

Name

Description

limit*

Type: string<int64>

Максимальное число элементов на странице.

offset*

Type: string<int64>

Смещение первого элемента списка относительно его начала.
Например, при значении "offset 5" список будет начинаться с шестого элемента.

total*

Type: string<int64>

Общее количество элементов в списке.

Coordinates

Name

Description

latitude*

Type: number<double>

Широта точки на карте.

longitude*

Type: number<double>

Долгота точки на карте.

SourceRef

Name

Description

serviceId

Type: string

Идентификатор сервиса, полученный от менеджера.

sourceId

Type: string

Идентификатор источника в базе данных.

No longer supported, please use an alternative and newer version.