[POST] …/v1/Country/get
Возвращает информацию о существующих странах в системе
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id стран |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
search | string | Необязательный | Строка поиска по полям name, fullname, alfa2, alfa3 |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id страны), Name (Наименование страны), FullName (Полное наименование страны), Code (Код страны), Alfa2 (Alfa2 код страны), Alfa3 (Alfa3 код страны), LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,2],
"sort_orders":
[
{
"column":'Name',
"direction":'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | array of Country | Обязательный | Массив объектов Country |
Пример ответа
{
"ok": true,
"result":
[
{
"id": 0,
"name": "Узбекистан",
"fullname": "Республика Узбекистан",
"code": "860",
"alfa2": "UZ",
"alfa3": "UZB",
"last_update": 1533619909
}
],
"next_offset": 0,
"total": 2
}