Метод проверяет, можно ли добавить аппаратный ключ к заказу, переданному в параметр пути {id}.
Заказ должен быть в статусе Подтвержден (Submit).
| Адрес | /v1.0/canadddongle/orders/{id} |
| Тип | POST |
| Login | Требуется |
Входные параметры
Входные параметры передаются в теле запроса в raw JSON:
| Параметр | Обязательность | Описание | Возможные значения |
|---|---|---|---|
dongleId | Обязателен | Идентификатор аппаратного ключа (выгравирован на корпусе) | |
dongleModel | Обязателен | Модель аппаратного ключа |
|
publicCode | Обязателен | Числовое значение публичного кода доступа вендора | |
typeFlags | Обязателен | Поле Type аппаратного ключа, которые определяет его свойства (поддержку алгоритмов, сетевого функционала и т. п.) | |
netResource | Обязателен | Cетевой ресурс аппаратного ключа |
https://station.guardant.ru/v1.0/canadddongle/orders/1062
{
"dongleId": 991846791,
"dongleModel": 2,
"publicCode": 1368487351,
"typeFlags": 0,
"netResource": 0
}
Ответ
Возвращает OK (200), если ключ может быть добавлен к заказу и соответствующую ошибку, если нет.
Если аппаратный ключ уже был ранее добавлен к заказу, то в ответе вернется OK.
Данный запрос для заказа на обновление вернет ошибку.
Могут получены следующие дополнительные ошибки:
- ключ не поддерживает ограниченные по времени компоненты (код ошибки 10172);
- ключ не поддерживает сетевой компонент (код ошибки 10173);
- общее количество сетевых компонентов превышает сетевой ресурс ключа (код ошибки 10174).
При получении ошибок 10172 и 10173 в ответе на запрос помимо описания ошибки также будут следующе поля: ID аппаратного ключа, номер компонента, номер продукта, номер заказа. Например:
{
"conflictedDongleId":999392418,
"conflictedFeatureNumber":16,
"conflictedOrderNumber":94,
"conflictedProductNumber":12350,
"status":{"code":10172,"description":"Dongle does not support time limited features","message":"Bad Request","status":400}
}
При получении ошибки 10174 в ответе на запрос помимо описания ошибки будет только значение ID аппаратного ключа.