Проверка нахождения в розыске¶
checkWanted¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/gibdd/checkWanted
Поддерживаются следующие форматы передачи параметров:
-
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 | Нет | Уникальный идентификатор операции |
| wantedList | Список объектов | Нет | Список объектов «Постановка в розыск». Подробнее см. информация о постановке в розыск |
Пример вызова (передача параметров в формате json):
POST /idx/api2/gibdd/checkWanted
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": " Выданный accessKey",
"secretKey": " Выданный secretKey ",
"vin": "17-значный VIN"
}
Пример ответа:
{
"resultCode":0,
"operationToken": "f1beebe2ff1e4927aff40444c33892c6",
"wantedList":[
{
"region":"город Москва",
"model":"ТОЙОТАПРИУС",
"year":"2008",
"wantedSince":"15.07.2014"
}]
}
Информация о постановке в розыск¶
Объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| model | String | Марка+модель авто |
| year | String | Год выпуска |
| region | String | Регион инициатора розыска |
| wantedSince | String | Дата постоянного учета в розыске |