Get

[POST] …/v1/Currency/Get

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

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

Название Тип данных Обязательность Описание
ids array of int64 Необязательный Массив с id валют
sort_orders array of SortOrders Необязательный Сортировака выходных параметров
search string Необязательный Строка поиска по: name (наименование), code_chr (Буквенный код)
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


SortOrders

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

Название Тип данных Описание
column enum Значение для сортировки: <Id | 1> (Id валюты), <Name | 2> (Наименование), <CodeNum | 3> (Цифровой код), <CodeChr | 4> (Буквенный код), <ExchangeRate | 5> (Курс), <LastUpdate | 6> (Последнее изменение)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "ids": [
        1
    ],
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "code_num": 123,
            "code_chr": "UZS",
            "name": "Узбекский сум",
            "exchange_rate": 1.1,
            "is_base": false,
            "deleted": false,
            "last_update": 1533619909
        }
    ],
    "next_offset": 1,
    "total": 1
}