Метод возвращает список лицензионных ключей (аппаратных и программных). 

Адрес/v1.0/reports/licensing_keys
ТипGET
LoginТребуется 

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

ПараметрОбязательностьОписаниеВозможные значения
sortby ОпционаленСортировка ключей.

По умолчанию выполняется сортировка по ID ключей (dongleid)

  • dongleid — сортировка по ID ключей;
  • activationdate — сортировка по дате первой активации (для серийных номеров)/дате первой прошивки (для аппаратных ключей);
  • model — сортировка по модели ключа;
  • customer — сортировка по покупателю, указанному в заказе;
  • ordernumber — сортировка по номеру заказа;
  • shipmentdate — сортировка по дате отгрузки заказа

direction

Опционален

Направление сортировки.

По умолчанию используется сортировка asc

  • asc — сортировка от меньшего к большему;
  • desc — сортировка от большего к меньшему

limit

Опционален

Максимальное количество записей, которые можно получить.

По умолчанию равен 100

От 1 до 100 включительно

offset

Опционален

Смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей.

Записи нумеруются с 0


from

Опционален

В отчет будут попадать только ключи, у которых дата первой активации/прошивки будет больше, чем дата, указанная в этом параметре (в формате Unix time)


to

Опционален

В отчет будут попадать только ключи, у которых дата первой активации/прошивки будет меньше, чем дата, указанная в этом параметре (в формате Unix time)


customers

Опционален

Список ID покупателей через запятую, чьи ключи попадут в отчет


istrial

Опционален

Фильтрация заказов на пробные лицензии.

По умолчанию в запросе возвращаются все заказы

  • false — вернутся только заказы на обычные лицензии;
  • true — вернутся только заказы на пробные лицензии
Пример запроса
https://station.guardant.ru/v1.0/reports/licensing_keys?sortby=dongleid&direction=desc&limit=2&offset=10&from=1586428828&to=1775731228&istrial=false

Ответ

Возвращает массив licensing_keys.

Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).

Пример результата запроса 
{
    "licensing_keys": [
        {
            "_id": 62115,
            "customer": {
                "_id": 13489,
                "companyname": "Johncompany",
                "email": "johncompany@mycompany.com",
                "lastname": "Doe",
                "name": "John"
            },
            "dongleid": -621473722,
            "first_activation_date": 1737019696,
            "model": 1,
            "order": {
                "_id": 59330,
                "customer": {
                    "_id": 13489,
                    "companyname": "Johncompany",
                    "email": "johncompany@mycompany.com",
                    "lastname": "Doe",
                    "name": "John"
                },
                "date": 0,
                "description": "",
                "ishardwarelicense": false,
                "istrial": false,
                "number": 46,
                "shipmentdate": 1737019444,
                "status": 8,
                "submitdate": 1737019444,
                "type": 0
            }
        },
        {
            "_id": 65575,
            "dongleid": -658476031,
            "first_activation_date": 1743758264,
            "model": 1,
            "order": {
                "_id": 63326,
                "date": 0,
                "description": "",
                "ishardwarelicense": false,
                "istrial": true,
                "number": 112,
                "shipmentdate": 1743758214,
                "status": 8,
                "submitdate": 1743758214,
                "type": 0
            }
        }
    ],
    "xcount": 48
}
  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru