Skip to content

Получение списка свободных карт у парнера

Метод для получения списка свободных карт у партнера в сервисе СУП. (список карт, которые не привязаны к сотрудникам)

URL

GET https://rest.lksup.ru/v1/cards/available

Описание

Метод возвращает результат списка свободных карт у партнера.

Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о странице — Данные для получения списка свободных карт.

Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.

Структура запроса

В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные о пагинации. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке)

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

Формат запроса:

GET https://rest.lksup.ru/v1/cards/available

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

{
            "page": integer,
            "per_page": integer
}

Параметры запроса

Параметр Тип Описание Обязательный Шифрование
page integer Номер получаемой страницы (значение по умолчанию = 1) Да Да
per_page integer Количество записей на странице (значение по умолчанию = 15) Да Да

Структура ответа

Пример успешного ответа - код 200

{
"data": [

        {
            "customCardId": "2031063001293",
            "orderId": "019715dd-1bb6-7f2e-bcc0-4d6d32a3578e",
            "typeCard": "MP4"
        },
        {
            "customCardId": "2031063001292",
            "orderId": "019715dd-1bb6-7f2e-bcc0-4d6d32a3578e",
            "typeCard": "MP4"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://rest.lksup.ru/v1/cards/available",
        "per_page": 100,
        "to": 65,
        "total": 65
    }
}

Параметры успешного ответа

Параметр Тип Описание
current_page string Номер текущей страницы
from string Номер записи, с которой начинается список
to string Номер записи, на которой заканчивается список
total string Количество всех записей
per_page string Количество записей на странице
last_page string Номер последней страницы
path string Путь
typeCard string MP4 - пластиковая карта СУП МИР,MLZ - Виртуальная карта СУП МИР
customIdCard string Идентификатор карты в банковской системе
data dict Словарь, содержащий данные по сотрудникам

Пример ответа с ошибкой

Ответы с ошибкой могут быть двух видов. Пример ответа для кода состояния 422

{

"data":[

{"field": "string",

"message": "string"}

]

}

Тело ответа для остальных 4хх:

{
"message": "string"
}

Возможные ошибки

Статус Описание
401 Не авторизован. Некорректный токен
422 Передано некорректное значение