Skip to content

Получить список городов Telegram#

Получение списка telegram городов

Метод используется для получения списка городов Telegram с поддержкой пагинации.

Ручка#

POST /ui/v1/fetch_tg_cities#

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/ui/v1/fetch_tg_cities
🚀 Prod https://mobile-api.terraprod.ru/admin/ui/v1/fetch_tg_cities
## Тело запроса
Поле Тип Описание Обязательность
pagination object Объект пагинации ✅
pagination.limit int Кол-во элементов на страницу ✅
pagination.page int Номер страницы (с 1) ✅

Пример JSON запроса#

{
    "pagination": {
        "currentPage": 1,
        "itemsPerPage": 2,
        "totalItems": 11,
        "totalPages": 6
    },
    "result": [
        {
            "city": "Москва",
            "description": "Добро пожаловать в Москву",
            "id": 1,
            "priority": 1
        },
        {
            "city": "Санкт-Петербург",
            "description": "Тут весело",
            "id": 2,
            "priority": 2
        }
    ]
}
Получение telegram города

Метод предназначен для получения одного или нескольких Telegram-городов

Ручка#

POST /ui/v1/get_tg_cities#

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/ui/v1/get_tg_cities
🚀 Prod https://mobile-api.terraprod.ru/admin/ui/v1/get_tg_cities

Тело запроса#

Поле Тип Описание Обязательность
id int Идентификатор Telegram-города (> 0) ✅

Пример JSON запроса#

{
  "id": 0
}

Пример JSON ответа#

{
  "city": "string",
  "description": "string",
  "id": 0,
  "priority": 0
}
Обновление данных telegram города

Ручка#

PATCH /ui/v1/update_tg_cities#

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/ui/v1/update_tg_cities
🚀 Prod https://mobile-api.terraprod.ru/admin/ui/v1/update_tg_cities

Тело запроса#

Поле Тип Описание Обязательность
id int Идентификатор города (> 0) ✅
city string Название города ❌
priority int Приоритет отображения (> 0) ❌
description string Описание города ❌

❗ Обязательно передавать хотя бы одно поле для обновления (помимо id).

Пример JSON запроса#

{
    "city": "string",
    "description": "string",
    "id": 0,
    "priority": 0
}

Пример JSON ответа#

200 OK "string"

Создание нового города

Ручка#

POST /ui/v1/create_tg_cities#

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/ui/v1/create_tg_cities
🚀 Prod https://mobile-api.terraprod.ru/admin/ui/v1/create_tg_cities

Тело запроса#

Поле Тип Описание Обязательность
city string Название Telegram-города ✅
priority int Приоритет отображения (> 0) ✅
description string Описание города ❌

Пример JSON запроса#

{
    "city": "string",
    "description": "string",
    "priority": 0
}

Пример JSON ответа#

{
    "id": 0
}
Удалить город

Ручка#

DELETE /ui/v1/delete_tg_cities#

Полный адрес в сети#

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/ui/v1/delete_tg_cities
🚀 Prod https://mobile-api.terraprod.ru/admin/ui/v1/delete_tg_cities

Тело запроса#

Поле Тип Описание Обязательность
id int32 Идентификатор города (> 0) ✅

Пример JSON запроса#

{
    "id": 0
}

Пример JSON ответа#

200 OK "string"