Получить список типов контрактов

Exodrive API (2.0)

Download OpenAPI description

swagger.json

swagger.yaml

Servers

DEV сервер

https://dev.api.exodrive.ai/

Аварии

Operations

Аномалии

Operations

Биллинг

Operations

Устройства

Operations

Ваучеры

Operations

Получить список типов контрактов

Request

Возвращает список доступных типов контрактов

Query

searchstring

Опциональный параметр поиска

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/Info/contractTypes?search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Unauthorized

Body

messagestring or null

Response

No response example

Создать новый ваучер

Request

Создает ваучер

Body

vipboolean or null

Признак VIP-статуса клиента. По умолчанию не передается в запросе.

clientUserIdinteger or null(int32)

Идентификатор клиента. По умолчанию не передается в запросе.

alterClientboolean or null

Флаг возможности изменения данных клиента. По умолчанию не передается в запросе.

alterDriverboolean or null

Флаг возможности изменения данных водителя. По умолчанию не передается в запросе.

clientobject(ClientCreationData)

contractobject(VoucherContractData)

vehicleobject(VoucherCreationVehicleRsa)

driverobject(Driver)

serviceIdsArray of integers or null(int32)

Список идентификаторов подключаемых сервисов.

contractTypeIdinteger(int32)

Уникальный идентификатор типа контракта. Используется для различных целей, включая биллинг, тип подключаемых моделей или тип транспортного средства. Получается через метод информации о типах контрактов.

curl -i -X POST \
  https://dev.api.exodrive.ai/api/v2/Voucher \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "vip": true,
    "clientUserId": 0,
    "alterClient": true,
    "alterDriver": true,
    "client": {
      "companyFlag": 0,
      "id": 0,
      "address": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "email": "string",
      "firstDrivingLicenseDate": "2019-08-24T14:15:22Z",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phone": "string",
      "phone2": "string",
      "phone3": "string",
      "homeAddress": "string",
      "drivingLicenseNumber": "string",
      "postCode": 0,
      "gender": 0
    },
    "contract": {
      "branch": "string",
      "closureDate": "2019-08-24T14:15:22Z",
      "closureTestDate": "2019-08-24T14:15:22Z",
      "commencementDate": "2019-08-24T14:15:22Z",
      "countryId": 0,
      "paymentDate": "2019-08-24T14:15:22Z",
      "fullInsurPremium": 0,
      "management": "string",
      "number": "string",
      "signatureDate": "2019-08-24T14:15:22Z",
      "terminalAffiliation": 0
    },
    "vehicle": {
      "vehicleIdentifier": 0,
      "regNumber": "string",
      "registrationDate": "2019-08-24T14:15:22Z",
      "serialNumber": "string",
      "vin": "string",
      "policyNumber": "string",
      "power": 0,
      "engineDisplacement": 0,
      "engineMileage": 0,
      "emissionStandardId": 0,
      "fuelType": 0,
      "modelVehicleId": 0,
      "carTypeId": 0,
      "colorId": 0,
      "driverCategory": 10,
      "productionYear": 0
    },
    "driver": {
      "id": 0,
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "gender": 0,
      "drivingLicenseNumber": "string",
      "firstDrivingLicenseDate": "2019-08-24T14:15:22Z",
      "email": "string",
      "phone": "string",
      "employerUserId": 0,
      "hidden": true,
      "sortOrder": 0.1,
      "rowVersion": "string",
      "phone2": "string",
      "phone3": "string"
    },
    "serviceIds": [
      0
    ],
    "contractTypeId": 0
  }'

Responses

Success

Body

idinteger(int32)

octoProcessingStatusinteger(int32)(OctoProcessingStatus)

Enum0123

actionsstring or null

numberinteger or null(int32)

contractNumberstring or null

contractTypeIdinteger or null(int32)

installersCodeinteger or null(int32)

groupIdstring or null

voucherObjectIdstring or null

creationDatestring or null(date-time)

firstInstallAppointmentSetstring or null(date-time)

firstInstallAppointmentstring or null(date-time)

activationDatestring or null(date-time)

installationPerformedByinteger or null(int32)

mobileTerminalMaintenanceAppointmentSetstring or null(date-time)

mobileTerminalMaintenanceAppointmentstring or null(date-time)

mobileTerminalMaintenancestring or null(date-time)

closureDatestring or null(date-time)

terminalUninstallDatestring or null(date-time)

signatureDatestring or null(date-time)

commencementDatestring or null(date-time)

contractClosureDatestring or null(date-time)

closureTestDatestring or null(date-time)

branchstring or null

managementstring or null

fullInsurancePremiuminteger(int32)

paymentDatestring or null(date-time)

shippingFirstNamestring or null

shippingLastNamestring or null

shippingAddressstring or null

shippingZipcodestring or null

shippingCitystring or null

contactFirstNamestring or null

contactLastNamestring or null

contactEmailstring or null

contactPrimaryPhonestring or null

contactSecondaryPhonestring or null

requestResultCodeinteger or null(int32)

requestStatusCodeinteger(int32)(VoucherRequestStatusCode)

Enum019121314

contractStatusinteger(int32)(ClientContractStatus)

Статус ваучера: 1 - открыт, 0 - закрыт.

Enum01

terminalAffiliationinteger(int32)(TerminalAffiliation)

Enum01

userIdinteger(int32)

obuIdinteger or null(int32)

vehicleIdinteger or null(int32)

countryIdinteger or null(int32)

recordVersioninteger(int32)

hiddenboolean

sortOrdernumber(float)

rowVersionstring or null(byte)

voucherStatusCycleinteger(int32)(VoucherStatusCycle)

Статус привязанного устройства: 0 - ожидает привязки,1 - ожидает активации,2 - активировано,3 - ошибка активации,4 - замена транспортного средства,5 - ошибка замены транспортного средства,6 - ожидает деактивации,7 - деактивировано,8 - ошибка деактивации.

Enum012345678

companyFlaginteger or null(int32)

clientLastOrCompanyNamestring or null

clientFirstNamestring or null

addressstring or null

zipCodestring or null

citystring or null

userFirstContractIdentifierstring or null

clientEmailstring or null

contactAdditionalPhonestring or null

vipboolean

Response

No response example

Получить список ваучеров

Request

Возвращает список ваучеров

Query

SortTargetstring

Поле сортировки, ключ из rowHeaders.

IsDescinteger(int32)

Направление сортировки: 1 - по убыванию, 0 - по возрастанию.

Filterstring

Поле фильтрации, ключ из rowHeaders. Поддерживает операторы фильтрации: contains - частичное совпадение (без учета регистра),eq - точное совпадение.
Формат: имя_поля~оператор~значение

Pageinteger(int32)

Номер страницы.

PerPageinteger(int32)[ 1 .. 100 ]

Элементов на странице. По умолчанию 20, максимум 100.

curl -i -X GET \
  'https://dev.api.exodrive.ai/api/v2/Voucher/table?Filter=string&IsDesc=0&Page=0&PerPage=1&SortTarget=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body

totalinteger(int64)

Количество элементов.

itemsArray of objects or null(VoucherTableResponseItem)

Массив элементов.

rowHeadersobject or null

Словарь доступных для сортировки или фильтрации полей.

Response

No response example

Закрыть ваучер

Request

Закрывает выбранный ваучер и прекращает сбор и данных по нему

Path

idinteger(int32)required

Идентификатор ваучера

curl -i -X POST \
  'https://dev.api.exodrive.ai/api/v2/Voucher/{id}/close' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body

voucherIdinteger(int32)

Идентификатор ваучера

Response

No response example

Привязать устройство к ваучеру

Request

Привязывает устройство к выбранному ваучеру. Если ваучер не был ранее активирован, то данная операция также активирует его.

Path

idinteger(int32)required

Идентификатор ваучера

Body

Данные устройства

voucherIdinteger(int32)

Идентификатор ваучера

imeistring or null

IMEI устройства

deviceSerialNumberstring or null

Серийный номер устройства

curl -i -X POST \
  'https://dev.api.exodrive.ai/api/v2/Voucher/{id}/device/attach' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "voucherId": 0,
    "imei": "string",
    "deviceSerialNumber": "string"
  }'

Responses

Success

Body

voucherIdinteger(int32)

Идентификатор ваучера

Response

No response example

Отвязать устройство от ваучера

Request

Отвязывает устройство от выбранного ваучера

Path

idinteger(int32)required

Идентификатор ваучера

curl -i -X POST \
  'https://dev.api.exodrive.ai/api/v2/Voucher/{id}/device/dettach' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Body

voucherIdinteger(int32)

Идентификатор ваучера

Response

No response example

Справочники

Operations

Скоринг

Operations

Exodrive API (2.0)

Аварии

Аномалии

Биллинг

Устройства

Ваучеры

Получить список типов контрактов

Request

Responses

Was this helpful?

Создать новый ваучер

Request

Responses

Was this helpful?

Получить список ваучеров

Request

Responses

Was this helpful?

Закрыть ваучер

Request

Responses

Was this helpful?

Привязать устройство к ваучеру

Request

Responses

Was this helpful?

Отвязать устройство от ваучера

Request

Responses

Was this helpful?

Справочники

Скоринг

Exodrive API (2.0)

Аварии

Аномалии

Биллинг

Устройства

Ваучеры

Получить список типов контрактов

Request

Responses

Was this helpful?

Создать новый ваучер

RequestExpand all

Responses

Was this helpful?

Получить список ваучеров

Request

Responses

Was this helpful?

Закрыть ваучер

Request

Responses

Was this helpful?

Привязать устройство к ваучеру

Request

Responses

Was this helpful?

Отвязать устройство от ваучера

Request

Responses

Was this helpful?

Справочники

Скоринг

Request