Проверка на участие в ДТП¶
checkDtp¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/gibdd/checkDtp
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| vin | String | Да | Идентификационный номер транспортного средства (VIN) |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| dtpList | Список объектов | Нет | Список объектов «Информация о ДТП». Подробнее см. информация о ДТП |
Пример вызова (передача параметров в формате json):
POST /idx/api2/gibdd/checkDtp
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": " Выданный accessKey",
"secretKey": " Выданный secretKey ",
"vin": "17-значный VIN"
}
Пример ответа:
{
"resultCode": 0,
"operationToken": "f1beebe2ff1e4927aff40444c33892c6",
"dtpList":[
{
"model":"HYUNDAI Sonata",
"year":"2004",
"damageState":"Повреждено",
"dtpMoment":"28.02.2018 15:00",
"dtpType":"Столкновение",
"dtpRegion":"Ленинградская область",
"dtpNumber":"780002345"
}, {
"model":"HYUNDAI Sonata",
"year":"2004",
"damageState":"Повреждено",
"dtpMoment":"22.04.2016 13:50",
"dtpType":"Столкновение",
"dtpRegion":"Московская область",
"dtpNumber":"230054321"
}]
}
Информация о ДТП¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| model | String | Марка+модель пострадавшего авто |
| year | String | Год выпуска |
| damageState | String | Повреждение |
| dtpMoment | String | Дата+время происшествия |
| dtpType | String | Тип происшествия |
| dtpRegion | String | Регион происшествия |
| dtpNumber | String | Номер происшествия в учетной базе ГИБДД |