Проверка наличия ограничений ТС¶

checkRestricted¶

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/gibdd/checkRestricted

Поддерживаются следующие форматы передачи параметров:

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	Нет	Уникальный идентификатор операции
restrictList	Список объектов	Нет	Список объектов «Ограничения». Подробнее см. информация об ограничениях

Пример вызова (передача параметров в формате json):

POST /idx/api2/gibdd/checkRestricted
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
        "accessKey": " Выданный accessKey",
        "secretKey": " Выданный secretKey ",
        "vin": "17-значный VIN" 
}

Пример ответа:

{
        "resultCode":0,
        "operationToken": "f1beebe2ff1e4927aff40444c33892c6",
        "restrictList":[
        {
                "model":"АУДИ 4",
                "year":"2004",
                "bodyNumber":"12345678901234567",
                "restrictRegion":"Чувашская Республика",
                "restrictDate":"30.01.2010",
                "restrictOrg":"ОВД или иные правоохр. органы",
                "restriction":"Запрет на регистрационные действия",
                "restrictCause":"ИЗМЕНЕНИЕ ИДЕНТИФИКАЦИОННОГО НОМЕРА. ОП-3 УМВД РФ ПО Г.ЧЕБОКСАРЫ",
                "restrictPhone":"8(999)1112233"
        }]
}

Информация об ограничениях¶

Объект, содержащий следующие атрибуты:

Атрибут	Тип	Описание
model	String	Марка+модель авто
year	String	Год выпуска
bodyNumber	String	Номер кузова
restrictRegion	String	Регион инициатора ограничения
restrictDate	String	Дата наложения ограничения
restrictOrg	String	Кем наложено ограничение
restriction	String	Ограничение
restrictCause	String	Основание ограничения
restrictPhone	String	Телефон инициатора наложения ограничения