Connectors Reference
CDK Drive Service Vehicles Associates identification, type, status, and customer information about a vehicle. The API will allow you to create, update, query, and retrieve service domain vehicle information in CDK.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Query vehicles |
|
|
Create a vehicle |
|
|
Query a vehicle by identifier |
|
|
Update a vehicle |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Query vehicles
Description: Query vehicles
Syntax:
CDKDriveServiceVehicles.queryVehicles ([Optional]string vin, [Optional]string licensePlateNum, [Optional]string customerId, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
vin |
string (Vin) |
Filters vehicles by VIN |
False |
|
|
licensePlateNum |
string (License Plate Number) |
Filters vehicles by license plate number |
False |
|
|
customerId |
string (Customer Id) |
Filters vehicles by customerId |
False |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
False |
Returns:
Type:VehicleCollection
Summary: Create a vehicle
Description: Create a vehicle
Syntax:
CDKDriveServiceVehicles.createVehicle (string client_id, string client_secret, string subscription_id, string Request-Id, [Optional]CreateVehicle createVehicle)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
|
|
createVehicle |
|
|
False |
Returns:
Type:Vehicle
Summary: Query a vehicle by identifier
Description: Query a vehicle by identifier
Syntax:
CDKDriveServiceVehicles.queryVehicleById (string vehicleId, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
vehicleId |
string (Vehicle Id) |
The vehicle identifier |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
False |
Returns:
Type:Vehicle
Summary: Update a vehicle
Description: Update a vehicle
Syntax:
CDKDriveServiceVehicles.updateVehicle (string vehicleId, string subscription_id, string client_id, string client_secret, [Optional]string Request-Id, string If-Match, [Optional]CreateVehicle createVehicle)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
vehicleId |
string (Vehicle Id) |
The vehicle identifier |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
False |
|
|
If-Match |
string (eTag Value) |
Makes the resource update request conditional. The checksum value presented with If-Match must match the current ETag value of the resource. |
True |
|
|
createVehicle |
|
|
False |
Returns:
Type:Vehicle
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
identification |
|
Vehicle identification. At least one of the identification properties must be defined for the entity to be valid. |
|
specification |
|
|
|
exteriorColor |
string
|
The vehicle exterior color |
|
mileage |
|
|
|
status |
string
|
Is the status of the vehicle new, used, or certified? Values: [NEW, USED, CERTIFIED] |
|
dates |
|
|
|
ownerHref |
string
|
The hyperlink to the owner customer resource |
|
primaryDriverHref |
string
|
The hyperlink to the primary driver customer resource |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
delivered |
string(date)
|
Delivery date of the vehicle to its current owner as defined by RFC 3339, section 5.6, for example, 2017-07-21 |
|
inService |
string(date)
|
Retail sale date to the original owner as defined by RFC 3339, section 5.6, for example, 2017-07-21 |
|
warrantyExpiration |
string(date)
|
Warranty Expiration date of the vehicle as defined by RFC 3339, section 5.6, for example, 2017-07-21 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
href |
string
|
The target URI |
|
method |
string
|
The HTTP verb that MUST be used to make a request to the target of the link |
|
title |
string
|
The title property provides a title for the link and is a helpful documentation tool to facilitate understanding by the end clients |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
number
|
The measurement value |
|
units |
string
|
The units of measurement Values: [MI, KM] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
vehicleId |
string
|
The idenifier of the vehicle record |
|
identification |
|
Vehicle identification. At least one of the identification properties must be defined for the entity to be valid. |
|
specification |
|
|
|
exteriorColor |
string
|
The vehicle exterior color |
|
mileage |
|
|
|
status |
string
|
Is the status of the vehicle new, used, or certified? Values: [NEW, USED, CERTIFIED] |
|
dates |
|
|
|
ownerHref |
string
|
The hyperlink to the owner customer resource |
|
primaryDriverHref |
string
|
The hyperlink to the primary driver customer resource |
|
links |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (Vehicle)
|
|
Summary:
Description: Vehicle identification. At least one of the identification properties must be defined for the entity to be valid.
Properties:
|
Name |
Type |
Summary |
|
vin |
string
|
The Vehicle Idenitification Number |
|
licensePlateNum |
string
|
The vehicle license plate number |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
self |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
makeCode |
string
|
The vehicle make code |
|
make |
string
|
The vehicle make name |
|
modelCode |
string
|
The vehicle model code |
|
model |
string
|
The vehicle model name |
|
modelYear |
number
|
The vehicle model year |