Получение информации о водительском удостоверении¶
getDriverInfo¶
Данный метод работает исключительно в режиме асинхронного выполнения. Подробнее, см. асинхронный режим выполнения запросов
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/getDriverInfo
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| drivingLicenseNumber | String | Да | Номер водительского удостоверения |
| lastName | String | Да | Фамилия |
| firstName | String | Да | Имя |
| midName | String | Нет | Отчество |
| birthDate | String | Да | Дата рождения в формате ДД.ММ.ГГГГ |
| isConsentAccepted | Boolean | Да | Признак согласия клиента на обработку его персональных данных (true – согласие дано, обязательное значение для обработки данных, false – согласие не дано) |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| birthPlace | String | Нет | Место рождения владельца водительского удостоверения |
| drivingLicenseIssueDate | String | Нет | Дата выдачи в формате DD.MM.YYYY |
| drivingLicenseExpiryDate | String | Нет | Срок действия в формате DD.MM.YYYY |
| drivingLicenseCategory | String | Нет | Категории |
| stagStart | Int | Нет | Год начала стажа |
| stag | Int | Нет | Водительский стаж (полных лет) |
| extensionPeriod | String | Нет | Период продления ВУ в формате ISO-8601 duration |
| decisionList | Array | Нет | Массив объектов – постановлений о лишении водительских прав. Подробнее см. Постановление о лишении прав |
Пример асинхронного вызова:
POST /idx/api2/getDriverInfo
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"drivingLicenseNumber": "9900123456",
"lastName": "ИВАНОВ",
"firstName": "ИВАН",
"midName": "ИВАНОВИЧ",
"birthDate": "10.01.1980",
"isConsentAccepted": true
}
Пример ответа на асинхронный запрос:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "82e9d47328947457353543565349"
}
operationToken используется для вызова getAsyncResult (подробнее см. getAsyncResult) для получения результата.
Пример успешного ответа, получаемого через getAsyncResult:
{
"resultCode": 0,
"operationToken": "82e9d47328947457353543565349",
"birthPlace": "Г МОСКВА",
"drivingLicenseIssueDate": "01.02.2015",
"drivingLicenseExpiryDate": "01.02.2025",
"drivingLicenseCategory": "B, B1",
"stagStart": 2010,
"stag": 16,
"extensionPeriod": "P3Y",
"decisionList": [*Постановление о лишении прав*]
}
Пример ответа, если данные о водительском стаже не найдены:
{
"resultCode": -100,
"operationToken": "82e9d47328947457353543565349"
}
Постановление о лишении прав¶
Объект «Постановление о лишении прав» включает следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| title | String | Тип документа |
| issuedAt | String | Дата постановления в формате DD.MM.YYYY |
| period | String | Срок лишения, ISO-8601 duration (например, P18M) |
| status | String | Текущая стадия исполнения |
Пример объекта «Постановление о лишении прав» в формате json:
{
"title": "Постановление",
"issuedAt": "01.02.2024",
"period": "P18M",
"status": "Начало течения срока лишения специального права"
}