Keyloop Partner Platform: Service Domain (v1)

Customer queries

Retrieve customer data

Customer Search

Search for customers using the filter criteria specified within the query parameters - at least one search parameter must be specified.

query Parameters
page
integer <int32>
pageSize
integer <int32>
givenName
string
familyName
string
email
string
phone
string
postalCode
string
socialSecurityId
string

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "items": [
    ],
  • "links": [
    ]
}

Get Customer

Retrieve a customer object for a given {customerId}

path Parameters
customerId
required
string

The unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "status": "ACTIVE",
  • "names": {
    },
  • "personalDetails": {
    },
  • "addresses": {
    },
  • "communication": {
    },
  • "links": [
    ]
}

Customer Privacy

Retrieve a customer privacy object list for a given {customerId}

path Parameters
customerId
required
string

The unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Customer identity

Retrieve customer identity object for a given {customerId}

path Parameters
customerId
required
string

The unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "socialSecurityId": "string",
  • "birthDate": "2019-08-24T14:15:22Z"
}

ByContractcodeByBusinessunitV1CustomersByCustomerIdCompaniesGet

path Parameters
customerId
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Customer Vehicles

Get list of vehicles associated with a customer object

path Parameters
customerId
required
string

The unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Customer privacy statements retrieval

Get a list of usable privacy statements for creating new customer privacy statement

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "privacyStatements": [
    ],
  • "links": [
    ]
}

Customer actions

Create, modify and delete customer data

Create Customer

Create a customer object

Request Body schema: application/json

Customer

status
string
Enum: "ACTIVE" "DECEASED" "CUSTOMER" "PROSPECT"
object (V1.Customer.CustomerNames)
object (V1.Customer.CustomerIdentity)
object (V1.Customer.CustomerPersonalDetails)
object (V1.Customer.CustomerAddresses)
object (V1.Customer.CustomerCommunication)
Array of objects (V1.Customer.CustomerPrivacy)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "names": {
    },
  • "identity": {
    },
  • "personalDetails": {
    },
  • "addresses": {
    },
  • "communication": {
    },
  • "privacy": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string"
}

Update Customer names

Update name details for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer names

object (V1.Customer.CustomerNames)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "names": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Update Customer personal details

Update personal details for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer personal details

object (V1.Customer.CustomerPersonalDetails)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "personalDetails": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Update Customer identity

Update identification details for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer identity

object (V1.Customer.CustomerIdentity)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "identity": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Update Customer Addresses

Update address details for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer addresses

object (V1.Customer.CustomerAddresses)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "addresses": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Update Customer Privacy

Update privacy information for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer privacies

Array of objects (V1.Customer.CustomerPrivacy)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "privacy": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Update Customer Communication

Update communication information for a customer object

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer communication

object (V1.Customer.CustomerCommunication)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "communication": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Customer Add Link to Vehicle

Link the customer to a vehicle

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer vehicle link

object (V1.Customer.CustomerVehicleLink)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "vehicleLink": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Customer Remove Link to Vehicle

Remove an existing link between the customer and a vehicle

path Parameters
customerId
required
string

Customer Id

Request Body schema: application/json

Customer vehicle link

object (V1.Customer.CustomerVehicleLink)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "vehicleLink": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Company queries

Retrieve company data

Company Search

Search for companies using the filter criteria specified within the query parameters - at least one search parameter must be specified.

query Parameters
page
integer <int32>
Default: 1

A non-zero integer representing the page of the results

pageSize
integer <int32>
Default: 50

A non-negative, non-zero integer indicating the maximum number of results to return at one time

name
string

Name filter

email
string

Given name filter

phone
string

Given name filter

postalCode
string

Postal code

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "items": [
    ],
  • "links": [
    ]
}

Get Company

Retrieve a company object for a given {companyId}

path Parameters
companyId
required
string

The unique id of the company

Responses

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "identification": {
    },
  • "addresses": {
    },
  • "communication": {
    },
  • "links": [
    ]
}

Company customers

Retrieve a list of customers associated with a company object

path Parameters
companyId
required
string

The unique id of the company

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Company Vehicles

Retrieve a list of vehicles associated with a company object

path Parameters
companyId
required
string

The unique id of the company

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Company external references

Gets a list of external references associated with a company object

path Parameters
companyId
required
string

The unique id of the company

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Company actions

Create, modify and delete company data

Create Company

Create a Company object

Request Body schema: application/json

Company

object (V1.Company.CompanyIdentification)
object (V1.Company.CompanyAddresses)
object (V1.Company.CompanyCommunication)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "addresses": {
    },
  • "communication": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "companyId": "string"
}

Update Company identification

Update the identification details for a company object

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company identification

object (V1.Company.CompanyIdentification)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Company Update Addresses

Update the address information for a company object

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company addresses payload

object (V1.Company.CompanyAddresses)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "addresses": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Company Update Communication

Update the communication information for a company object

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company identity

object (V1.Company.CompanyCommunication)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "communication": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Company Add Link to Customer

Link a customer to a company object

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company customer link

object (V1.Company.CompanyCustomerLink)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "customerLink": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Company Remove Link to Customer

Remove the link between a customer and the company specified by {companyId}

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company customer link

object (V1.Company.CompanyCustomerLink)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "customerLink": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Add external reference to company

Add external reference to company

path Parameters
companyId
required
string

Company Id

Request Body schema: application/json

Company External Reference

object (V1.Company.CompanyExternalReference)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "externalReference": {
    },
  • "metadata": {
    }
}

Health

Endpoint for checking the health of the api

ByContractcodeByBusinessunitPingGet

Responses

Service History queries

Retrieve service history details

Service History details

Get the Service History details for a specific Service History Id

path Parameters
serviceHistoryId
required
string

Service History Id

Responses

Response samples

Content type
application/json
{
  • "serviceHistoryId": "string",
  • "serviceDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "serviceMileage": {
    },
  • "vehicle": {
    },
  • "workshop": {
    },
  • "menus": [
    ],
  • "labors": [
    ],
  • "parts": [
    ],
  • "texts": [
    ],
  • "links": [
    ]
}

Service History search

Search for a Service History record using the filter criteria specified within the query parameters - at least one search parameter must be specified.

query Parameters
vin
string

Vehicle VIN used for filtering the results

page
integer <int32>
pageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "serviceHistoryEntries": [
    ],
  • "links": [
    ]
}

Utility actions

Create, modify and delete utility data

Get lookup data list

Returns a list of the lookup data for the given lookup filter .

query Parameters
filterKey
string

Lookup data filter

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "items": [
    ],
  • "links": [
    ]
}

Get user

Returns a user (salesman).

path Parameters
userId
required
string

User id

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "name": "string",
  • "email": "string",
  • "jobTitle": "string",
  • "links": [
    ]
}

Get user list

Returns a list of the users (salesman) that this specific dealer has.

query Parameters
page
integer <int32>
Default: 1

A non-zero integer representing the page of the results

pageSize
integer <int32>
Default: 50

A non-negative, non-zero integer indicating the maximum number of results to return at one time

userId
string

Filter with user id

email
string

Filter with e-mail

name
string

Filter with name

jobTitle
string

Filter with job title

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "items": [
    ],
  • "links": [
    ]
}

Vehicle queries

Retrieve vehicle data

Vehicle Search

Search for vehicles using the filter criteria specified within the query parameters - at least one search parameter must be specified.

query Parameters
page
integer <int32>
Default: 1

A non-zero integer representing the page of the results

pageSize
integer <int32>
Default: 50

A non-negative, non-zero integer indicating the maximum number of results to return at one time

vin
string

VIN filter

licensePlate
string

License plate filter

Responses

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "totalPages": 0,
  • "items": [
    ],
  • "links": [
    ]
}

Vehicle

Retreive a vehicle object for a given {vehicleId}

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
application/json
{
  • "vehicleId": "string",
  • "identification": {
    },
  • "description": {
    },
  • "referenceData": [
    ],
  • "mileage": {
    },
  • "nextService": {
    },
  • "dates": {
    },
  • "links": [
    ]
}

Vehicle List Customers

Get list of customers associated with a vehicle object

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Vehicle Inspections

Get inspections associated with a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Responses

Response samples

Content type
application/json
{
  • "inspections": {
    },
  • "links": [
    ]
}

Vehicle actions

Create, modify and delete vehicle data

Create Vehicle

Create a vehicle object

Request Body schema: application/json

Vehicle

object (V1.Vehicle.VehicleIdentification)
object (V1.Vehicle.VehicleDescription)
Array of objects (V1.Vehicle.VehicleReferenceData)
object (V1.Vehicle.VehicleMileage)
object (V1.Vehicle.VehicleDates)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "description": {
    },
  • "referenceData": [
    ],
  • "mileage": {
    },
  • "dates": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "vehicleId": "string"
}

Vehicle Update Dates

Update the dates belonging to a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle dates

object (V1.Vehicle.VehicleDates)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "dates": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Description

Update the descriptive details of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle description

object (V1.Vehicle.VehicleDescription)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "description": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Identification

Update the identification details of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle identification

object (V1.Vehicle.VehicleIdentification)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Mileage

Update the mileage of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle mileage

object (V1.Vehicle.VehicleMileage)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "mileage": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Reference Data

Update the reference data of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle referenceData

object (V1.Vehicle.VehicleReferenceData)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "referenceData": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Inspections

Update Inspections details of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle InspectionsUpdatePayload

object (V1.Vehicle.InspectionUpdate)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "vehicleInspection": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle Update Next Service

Update the Next Service of a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Vehicle nextService

object (V1.Vehicle.VehicleNextService)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "nextService": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}

Vehicle contract queries

Retrieve vehicle contract data

Get Vehicle Contracts

Get all contracts that belong to a vehicle

path Parameters
vehicleId
required
string

Vehicle Id

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "links": [
    ]
}

Get Vehicle Contract

Get a particular contract that belong to a vehicle using contract ID

path Parameters
vehicleId
required
string

Vehicle Id

contractId
required
string

Contract Id

Responses

Response samples

Content type
application/json
{
  • "contract": {
    },
  • "links": [
    ]
}

Vehicle contract actions

Create, modify vehicle contract data

Create new vehicle contract entry

Create a contract associated with a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

Request Body schema: application/json

Contract to create

type
string
Enum: "MANUFACTURER" "EXTENDED" "SERVICE" "BODY" "OTHER"

Contract type

description
string

Contract description

referenceId
string

External contract reference ID

startDate
string <date-time>

Contract start date

endDate
string <date-time>

Contract end date

object (V1.Vehicle.Mileage)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "type": "MANUFACTURER",
  • "description": "string",
  • "referenceId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "maxMileage": {
    },
  • "metadata": {
    }
}

Update vehicle contract

update a specific contract detail associated with a vehicle object

path Parameters
vehicleId
required
string

Vehicle Id

contractId
required
string

Contract id to update

Request Body schema: application/json

Contract to update

contractId
string

The contract ID

type
string
Enum: "MANUFACTURER" "EXTENDED" "SERVICE" "BODY" "OTHER"

Contract type

description
string

Contract description

referenceId
string

External contract reference ID

startDate
string <date-time>

Contract start date

endDate
string <date-time>

Contract end date

object (V1.Vehicle.Mileage)
object (V1.Metadata)

Responses

Request samples

Content type
application/json
{
  • "contractId": "string",
  • "type": "MANUFACTURER",
  • "description": "string",
  • "referenceId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "maxMileage": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "correlationId": "string",
  • "message": "string",
  • "informationLink": "string",
  • "details": [
    ],
  • "links": [
    ]
}