Получение VIN по ГРЗ¶
getVinByGosnomer¶
Данный метод поддерживает режим асинхронного выполнения (параметр async). Подробнее, см. асинхронный режим выполнения запросов
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/getVinByGosnomer
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| gosnomer | String | Да | Государственный регистрационный номер авто |
| async | Boolean | Нет | Признак асинхронного вызова |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -35 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| vin | String | Нет | Идентификационный номер транспортного средства (VIN) |
Пример вызова (передача параметров в формате json):
POST /idx/api2/getVinByGosnomer
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": " Выданный accessKey",
"secretKey": " Выданный secretKey ",
"gosnomer": "A123УУ45"
}
Пример ответа:
{
"resultCode":0,
"operationToken": "3ff6314a75ab4a19a64b2118d3f53825",
"vin": "12345678901234567"
}
Пример асинхронного запроса в формате json:
POST /idx/api2/getVinByGosnomer
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": " Выданный accessKey",
"secretKey": " Выданный secretKey ",
"gosnomer": "A123УУ45",
"async": true
}
Пример ответа на асинхронный запрос:
{
"resultCode": 0,
"operationToken": "c7cb6d9228dd4adda2b8775f9554b325",
"resultMessage": " "
}
operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.