Поделиться через

CDK Drive Service Vehicles (Preview)

  • 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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name CDK Global
URL https://serviceconnect.support.cdk.com
Email [email protected]
Connector Metadata
Publisher CDK Global
Website https://fortellis.io
Privacy policy https://fortellis.io/privacy
Categories Data

CDK Drive - Service - Vehicles Associates identification, type, status, and customer information about a vehicle.

What does this API do? The API will allow you to create, update, query, and retrieve service domain vehicle information in CDK Drive.

Intended Audience Vehicle is a dependency for Service Appointment and Service Repair Order workflows.

Pre-requisites

You will need the following to proceed

• To use the connector, you need to be a Fortellis user.

• You need to create an solution in Fortellis to generate client id and secret to be used while calling the APIs

Potential Use Cases

Use the CDKDrive Service Vehicles API to create solutions to handle situations such as:

  1. Create or update service vehicle information
  2. Link a customer to a service vehicle
  3. Search for existing service vehicles by ID or filter criteria

Detailed Documentation can be found at

https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a vehicle

Create a vehicle
Query a vehicle by identifier

Query a vehicle by identifier
Query vehicles

Query vehicles
Update a vehicle

Update a vehicle

Create a vehicle

Operation ID:
createVehicle

Create a vehicle

Parameters

Name Key Required Type Description
Client Id
 client_id True string

A client ID that should be unique to developer/solution provider building the solution.
Client Secret
 client_secret True string

A client secret that should be unique to developer/solution provider building the solution.
Subscription Id
 subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.
Request Id
 Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request
vin
 vin string

The Vehicle Idenitification Number
licensePlateNum
 licensePlateNum string

The vehicle license plate number
makeCode
 makeCode True string

The vehicle make code
make
 make string

The vehicle make name
modelCode
 modelCode True string

The vehicle model code
model
 model string

The vehicle model name
modelYear
 modelYear True number

The vehicle model year
exteriorColor
 exteriorColor string

The vehicle exterior color
value
 value True number

The measurement value
units
 units True string

The units of measurement
status
 status True string

Is the status of the vehicle new, used, or certified?
delivered
 delivered True date

Delivery date of the vehicle to its current owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
inService
 inService True date

Retail sale date to the original owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
warrantyExpiration
 warrantyExpiration date

Warranty Expiration date of the vehicle as defined by RFC 3339, section 5.6, for example, 2017-07-21
ownerHref
 ownerHref string

The hyperlink to the owner customer resource
primaryDriverHref
 primaryDriverHref string

The hyperlink to the primary driver customer resource

Returns

Body
Vehicle

Query a vehicle by identifier

Operation ID:
queryVehicleById

Query a vehicle by identifier

Parameters

Name Key Required Type Description
Vehicle Id
 vehicleId True string

The vehicle identifier
Subscription Id
 subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id
 client_id True string

A client ID that should be unique to developer/solution provider building the solution.
Client Secret
 client_secret True string

A client secret that should be unique to developer/solution provider building the solution.
Request Id
 Request-Id string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Body
Vehicle

Query vehicles

Operation ID:
queryVehicles

Query vehicles

Parameters

Name Key Required Type Description
Vin
 vin string

Filters vehicles by VIN
License Plate Number
 licensePlateNum string

Filters vehicles by license plate number
Customer Id
 customerId string

Filters vehicles by customerId
Subscription Id
 subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id
 client_id True string

A client ID that should be unique to developer/solution provider building the solution.
Client Secret
 client_secret True string

A client secret that should be unique to developer/solution provider building the solution.
Request Id
 Request-Id string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Body
VehicleCollection

Update a vehicle

Operation ID:
updateVehicle

Update a vehicle

Parameters

Name Key Required Type Description
Vehicle Id
 vehicleId True string

The vehicle identifier
Subscription Id
 subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id
 client_id True string

A client ID that should be unique to developer/solution provider building the solution.
Client Secret
 client_secret True string

A client secret that should be unique to developer/solution provider building the solution.
Request Id
 Request-Id string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request
eTag Value
 If-Match True string

Makes the resource update request conditional. The checksum value presented with If-Match must match the current ETag value of the resource.
vin
 vin string

The Vehicle Idenitification Number
licensePlateNum
 licensePlateNum string

The vehicle license plate number
makeCode
 makeCode True string

The vehicle make code
make
 make string

The vehicle make name
modelCode
 modelCode True string

The vehicle model code
model
 model string

The vehicle model name
modelYear
 modelYear True number

The vehicle model year
exteriorColor
 exteriorColor string

The vehicle exterior color
value
 value True number

The measurement value
units
 units True string

The units of measurement
status
 status True string

Is the status of the vehicle new, used, or certified?
delivered
 delivered True date

Delivery date of the vehicle to its current owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
inService
 inService True date

Retail sale date to the original owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
warrantyExpiration
 warrantyExpiration date

Warranty Expiration date of the vehicle as defined by RFC 3339, section 5.6, for example, 2017-07-21
ownerHref
 ownerHref string

The hyperlink to the owner customer resource
primaryDriverHref
 primaryDriverHref string

The hyperlink to the primary driver customer resource

Returns

Body
Vehicle

Definitions

Vehicle

Name Path Type Description
vehicleId
 vehicleId string

The idenifier of the vehicle record
identification
 identification VehicleIdentification

Vehicle identification. At least one of the identification properties must be defined for the entity to be valid.
specification
 specification VehicleSpecification
exteriorColor
 exteriorColor string

The vehicle exterior color
mileage
 mileage Measurement
status
 status string

Is the status of the vehicle new, used, or certified?
dates
 dates Dates
ownerHref
 ownerHref string

The hyperlink to the owner customer resource
primaryDriverHref
 primaryDriverHref string

The hyperlink to the primary driver customer resource
links
 links VehicleLinks

VehicleIdentification

Vehicle identification. At least one of the identification properties must be defined for the entity to be valid.

Name Path Type Description
vin
 vin string

The Vehicle Idenitification Number
licensePlateNum
 licensePlateNum string

The vehicle license plate number
Name Path Type Description
Details of a link to a resource
 self LinkDescriptionObject

VehicleCollection

Name Path Type Description
items
 items array of Vehicle

VehicleSpecification

Name Path Type Description
makeCode
 makeCode string

The vehicle make code
make
 make string

The vehicle make name
modelCode
 modelCode string

The vehicle model code
model
 model string

The vehicle model name
modelYear
 modelYear number

The vehicle model year

Measurement

Name Path Type Description
value
 value number

The measurement value
units
 units string

The units of measurement

Dates

Name Path Type Description
delivered
 delivered date

Delivery date of the vehicle to its current owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
inService
 inService date

Retail sale date to the original owner as defined by RFC 3339, section 5.6, for example, 2017-07-21
warrantyExpiration
 warrantyExpiration date

Warranty Expiration date of the vehicle as defined by RFC 3339, section 5.6, for example, 2017-07-21

LinkDescriptionObject

Name Path Type Description
href
 href string

The target URI
method
 method string

The HTTP verb that MUST be used to make a request to the target of the link
title
 title string

The title property provides a title for the link and is a helpful documentation tool to facilitate understanding by the end clients