Get

[POST] …/v1/Country/Get

Возвращает информацию о существующих странах в системе.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of Int64 Необязательный Массив id стран
code Array of String Необязательный Массив кодов стран
sort_orders Array of SortOrders Необязательный Сортировки выходных данных
search String Необязательный Строка поиска по полям name, fullname, alfa2, alfa3
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


SortOrders

Модель сортировки выходных параметров

Название Тип данных Описание
column enum Значение для сортировки: <Id | 1> (Id страны), <Name | 2> (Наименование страны), <FullName | 3> (Полное наименование страны), <Code | 4> (Код страны), <Alfa2 | 5> (Alfa2 код страны), <Alfa3 | 6> (Alfa3 код страны), <LastUpdate | 7> (Дата изменения)
direction enum Порядок сортировки: <ASC | 1> (по возростанию), <DESC | 2> (по убыванию)

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

{
    "ids": [
        1
    ],
    "code": [
        "000001"
    ],
    "sort_orders": [
        {
            "column": "example",
            "direction": "ASC"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 0
}

Выходные параметры

Название Тип данных Описание
result array of Country Массив стран
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": 
        [
            {
                "id": 0,
                "name": "Узбекистан",
                "fullname": "Республика Узбекистан",
                "code": "860",
                "alfa2": "UZ",
                "alfa3": "UZB",
                "last_update": 1533619909
            }
        ],
    "next_offset": 1,
    "total": 1
}