Получение коэффициента бонус-малус¶
getKBM¶
Данный вызов недоступен в личном кабинете
Для подключения обратитесь на support@iidx.ru
Данный метод работает исключительно в режиме асинхронного выполнения. Подробнее, см. асинхронный режим выполнения запросов
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/getKBM
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| lastName | String | Да | Фамилия |
| firstName | String | Да | Имя |
| midName | String | Да (при наличии) | Отчество |
| birthDate | String | Да | Дата рождения в формате ДД.ММ.ГГГГ |
| driverLicense | String | Да | Номер водительского удостоверения |
| kbmDate | String | Нет | Дата, на которую запрашивается КБМ в формате ДД.ММ.ГГГГ |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| dataList | Массив типа dataList | Нет | Массив объектов – данных с результатом получения. |
Данные отчёта находятся в объекте dataList[].content.kbms[] тела ответа.
Пример асинхронного вызова:
POST /idx/api2/getKBM
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"driverLicense": "0000123456"
}
Пример ответа на асинхронный запрос:
{
"resultCode": 0,
"operationToken": "82e9d47328947457353543565349",
"resultMessage": ""
}
operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.
Пример успешного ответа, получаемого через getAsyncResult:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "82e9d6ec643242e348bbefbe4d7b",
"dataList": [
{
"content": {
"kbms": [
{
"kbmDate": "2022-10-09",
"kbmValue": 1.17,
"kbmClass": "3",
"accidents": null
}
]
}
}
]
}
Данные объекта kbms¶
Объект «kbms» включает следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| dataList | List | Список объектов типа Data Данные по проверке КБМ. |
Данные по проверке КБМ¶
| Атрибут | Тип | Описание |
|---|---|---|
| kbmDate | String | Дата КБМ в формате YYYY-DD-MM |
| kbmValue | Double | Численное значение КБМ |
| kbmClass | String | Класс КБМ (вычисляется согласно соответствующим таблицам ОСАГО на 01.04.2022) |
| accidents | List | Список объектов типа Accident Описание объекта Accidient. |
Описание объекта Accidient¶
| Атрибут | Тип | Описание |
|---|---|---|
| date | String | Дата страхового случая в формате YYYY-DD-MM hh |
| policySerial | String | Серия полиса ОСАГО |
| policyNumber | String | Номер полиса ОСАГО |
| insurerName | String | Название страховой компании |
Пример объекта kbms в формате json:
{
"kbmDate": "2022-10-09",
"kbmValue": 1.17,
"kbmClass": "3",
"accidents": null
}