Keyloop Partner Platform: Service Domain (v1)
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 |
string | |
phone | string |
postalCode | string |
socialSecurityId | string |
Responses
Response samples
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "items": [
- {
- "customerId": "string",
- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}, - "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}
}, - "communication": {
- "home": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "work": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Get Customer
Retrieve a customer object for a given {customerId}
path Parameters
customerId required | string The unique id of the customer |
Responses
Response samples
- 200
- 404
{- "customerId": "string",
- "status": "ACTIVE",
- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}, - "personalDetails": {
- "gender": "UNKNOWN",
- "maritalStatus": "UNKNOWN",
- "languageCode": "string",
- "nationalityCountryCode": "string"
}, - "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}
}, - "communication": {
- "home": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "work": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}
}, - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
- 404
{- "items": [
- {
- "privacyStatementId": "string",
- "level": "OEM",
- "usage": "PRIVATE",
- "providerName": "string",
- "description": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "channel": {
- "post": "UNKNOWN",
- "email": "UNKNOWN",
- "phone": "UNKNOWN",
- "messaging": "UNKNOWN"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
- 404
{- "items": [
- {
- "vehicleId": "string",
- "relationship": "UNKNOWN",
- "vehicleDescription": "string",
- "vin": "string",
- "licensePlate": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Customer privacy statements retrieval
Get a list of usable privacy statements for creating new customer privacy statement
Responses
Response samples
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "privacyStatements": [
- {
- "privacyStatementId": "string",
- "level": "OEM",
- "providerName": "string",
- "description": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "status": "ACTIVE",
- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}, - "identity": {
- "socialSecurityId": "string",
- "birthDate": "2019-08-24T14:15:22Z"
}, - "personalDetails": {
- "gender": "UNKNOWN",
- "maritalStatus": "UNKNOWN",
- "languageCode": "string",
- "nationalityCountryCode": "string"
}, - "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}
}, - "communication": {
- "home": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "work": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}
}, - "privacy": [
- {
- "privacyStatementId": "string",
- "level": "OEM",
- "usage": "PRIVATE",
- "providerName": "string",
- "description": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "channel": {
- "post": "UNKNOWN",
- "email": "UNKNOWN",
- "phone": "UNKNOWN",
- "messaging": "UNKNOWN"
}
}
], - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 201
{- "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
- Payload
{- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "personalDetails": {
- "gender": "UNKNOWN",
- "maritalStatus": "UNKNOWN",
- "languageCode": "string",
- "nationalityCountryCode": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "identity": {
- "socialSecurityId": "string",
- "birthDate": "2019-08-24T14:15:22Z"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "privacy": [
- {
- "privacyStatementId": "string",
- "level": "OEM",
- "usage": "PRIVATE",
- "providerName": "string",
- "description": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validTo": "2019-08-24T14:15:22Z",
- "channel": {
- "post": "UNKNOWN",
- "email": "UNKNOWN",
- "phone": "UNKNOWN",
- "messaging": "UNKNOWN"
}
}
], - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "communication": {
- "home": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "work": {
- "mobile": "string",
- "landline": "string",
- "fax": "string",
- "email": "string"
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "vehicleLink": {
- "vehicleId": "string",
- "relationship": "UNKNOWN",
- "vehicleDescription": "string",
- "vin": "string",
- "licensePlate": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "vehicleLink": {
- "vehicleId": "string",
- "relationship": "UNKNOWN",
- "vehicleDescription": "string",
- "vin": "string",
- "licensePlate": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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 |
string Given name filter | |
phone | string Given name filter |
postalCode | string Postal code |
Responses
Response samples
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "items": [
- {
- "companyId": "string",
- "identification": {
- "name": "string",
- "languageCode": "string",
- "taxRegistration": "string",
- "businessRegistration": "string",
- "governmentRegistration": "string"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Get Company
Retrieve a company object for a given {companyId}
path Parameters
companyId required | string The unique id of the company |
Responses
Response samples
- 200
- 404
{- "companyId": "string",
- "identification": {
- "name": "string",
- "languageCode": "string",
- "taxRegistration": "string",
- "businessRegistration": "string",
- "governmentRegistration": "string"
}, - "addresses": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}, - "communication": {
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
- 404
{- "items": [
- {
- "customerId": "string",
- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
- 404
{- "items": [
- {
- "vehicleId": "string",
- "vehicleDescription": "string",
- "vin": "string",
- "licensePlate": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
{- "items": [
- {
- "providerCode": "string",
- "applicationCode": "string",
- "value": "string",
- "url": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "identification": {
- "name": "string",
- "languageCode": "string",
- "taxRegistration": "string",
- "businessRegistration": "string",
- "governmentRegistration": "string"
}, - "addresses": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}, - "communication": {
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 201
{- "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
- Payload
{- "identification": {
- "name": "string",
- "languageCode": "string",
- "taxRegistration": "string",
- "businessRegistration": "string",
- "governmentRegistration": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "addresses": {
- "physicalAddress": {
- "streetType": "string",
- "streetName": "string",
- "houseNumber": "string",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}, - "postalAddress": {
- "poBoxName": "string",
- "poBoxNumber": "string",
- "poBoxSuite": "string",
- "postalCode": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "province": "string",
- "countryCode": "string"
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "communication": {
- "landline": "string",
- "fax": "string",
- "email": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "customerLink": {
- "customerId": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "customerLink": {
- "customerId": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "externalReference": {
- "providerCode": "string",
- "applicationCode": "string",
- "value": "string",
- "url": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
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
- 200
- 404
{- "serviceHistoryId": "string",
- "serviceDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "serviceMileage": {
- "unit": "KM",
- "value": 0
}, - "vehicle": {
- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}, - "referenceData": {
- "providerId": "string",
- "makeCode": "string",
- "modelCode": "string",
- "variantCode": "string",
- "vehicleCode": "string",
- "serviceGroupCode": "string",
- "exteriorColorCode": "string",
- "interiorColorCode": "string"
}
}, - "workshop": {
- "name": "string"
}, - "menus": [
- {
- "description": "string",
- "labors": [
- {
- "description": "string",
- "code": "string",
- "allowedTimeInMinutes": 0
}
], - "parts": [
- {
- "description": "string",
- "code": "string",
- "quantity": 0
}
], - "texts": [
- {
- "description": "string"
}
]
}
], - "labors": [
- {
- "description": "string",
- "code": "string",
- "allowedTimeInMinutes": 0
}
], - "parts": [
- {
- "description": "string",
- "code": "string",
- "quantity": 0
}
], - "texts": [
- {
- "description": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "serviceHistoryEntries": [
- {
- "vehicle": {
- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}, - "referenceData": {
- "providerId": "string",
- "makeCode": "string",
- "modelCode": "string",
- "variantCode": "string",
- "vehicleCode": "string",
- "serviceGroupCode": "string",
- "exteriorColorCode": "string",
- "interiorColorCode": "string"
}
}, - "serviceHistory": [
- {
- "serviceHistoryId": "string",
- "serviceDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "serviceMileage": {
- "unit": "KM",
- "value": 0
}, - "workshop": {
- "name": "string"
}
}
]
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "items": [
- {
- "code": "string",
- "description": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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 |
string Filter with e-mail | |
name | string Filter with name |
jobTitle | string Filter with job title |
Responses
Response samples
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "items": [
- {
- "userId": "string",
- "name": "string",
- "email": "string",
- "jobTitle": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
{- "totalItems": 0,
- "totalPages": 0,
- "items": [
- {
- "vehicleId": "string",
- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Vehicle
Retreive a vehicle object for a given {vehicleId}
path Parameters
vehicleId required | string |
Responses
Response samples
- 200
- 404
{- "vehicleId": "string",
- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}, - "referenceData": [
- {
- "providerId": "string",
- "makeCode": "string",
- "modelCode": "string",
- "variantCode": "string",
- "vehicleCode": "string",
- "serviceGroupCode": "string",
- "exteriorColorCode": "string",
- "interiorColorCode": "string"
}
], - "mileage": {
- "unit": "KM",
- "value": 0
}, - "nextService": {
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "dueMileage": {
- "unit": "KM",
- "value": 0
}
}, - "dates": {
- "registrationDate": "2019-08-24T14:15:22Z",
- "firstRegistrationDate": "2019-08-24T14:15:22Z"
}, - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Vehicle List Customers
Get list of customers associated with a vehicle object
path Parameters
vehicleId required | string |
Responses
Response samples
- 200
- 404
{- "items": [
- {
- "customerId": "string",
- "relationship": "UNKNOWN",
- "names": {
- "familyName": "string",
- "familyName2": "string",
- "middleName": "string",
- "givenName": "string",
- "preferredName": "string",
- "initials": "string",
- "salutation": "string",
- "titleCommon": "string"
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Vehicle Inspections
Get inspections associated with a vehicle object
path Parameters
vehicleId required | string Vehicle Id |
Responses
Response samples
- 200
- 404
{- "inspections": {
- "vehicleInspection": {
- "lastDate": "2019-08-24T14:15:22Z",
- "dueDate": "2019-08-24T14:15:22Z"
}
}, - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}, - "referenceData": [
- {
- "providerId": "string",
- "makeCode": "string",
- "modelCode": "string",
- "variantCode": "string",
- "vehicleCode": "string",
- "serviceGroupCode": "string",
- "exteriorColorCode": "string",
- "interiorColorCode": "string"
}
], - "mileage": {
- "unit": "KM",
- "value": 0
}, - "dates": {
- "registrationDate": "2019-08-24T14:15:22Z",
- "firstRegistrationDate": "2019-08-24T14:15:22Z"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 201
{- "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
- Payload
{- "dates": {
- "registrationDate": "2019-08-24T14:15:22Z",
- "firstRegistrationDate": "2019-08-24T14:15:22Z"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "description": {
- "class": "UNKNOWN",
- "make": "string",
- "model": "string",
- "variant": "string",
- "modelYear": 0,
- "vehicle": "string",
- "exteriorColor": "string",
- "interiorColor": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "identification": {
- "vin": "string",
- "chassis": "string",
- "licensePlate": "string",
- "engineNumber": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "mileage": {
- "unit": "KM",
- "value": 0
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "referenceData": {
- "providerId": "string",
- "makeCode": "string",
- "modelCode": "string",
- "variantCode": "string",
- "vehicleCode": "string",
- "serviceGroupCode": "string",
- "exteriorColorCode": "string",
- "interiorColorCode": "string"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "vehicleInspection": {
- "dueDate": "2019-08-24T14:15:22Z"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "nextService": {
- "description": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "dueMileage": {
- "unit": "KM",
- "value": 0
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
Get Vehicle Contracts
Get all contracts that belong to a vehicle
path Parameters
vehicleId required | string Vehicle Id |
Responses
Response samples
- 200
- 404
{- "items": [
- {
- "contractId": "string",
- "type": "MANUFACTURER",
- "description": "string",
- "referenceId": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "maxMileage": {
- "unit": "KM",
- "value": 0
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- 200
- 404
{- "contract": {
- "contractId": "string",
- "type": "MANUFACTURER",
- "description": "string",
- "referenceId": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "maxMileage": {
- "unit": "KM",
- "value": 0
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}, - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}
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
- Payload
{- "type": "MANUFACTURER",
- "description": "string",
- "referenceId": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "maxMileage": {
- "unit": "KM",
- "value": 0
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
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
- Payload
{- "contractId": "string",
- "type": "MANUFACTURER",
- "description": "string",
- "referenceId": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "maxMileage": {
- "unit": "KM",
- "value": 0
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "name": "string",
- "correlationId": "string",
- "message": "string",
- "informationLink": "string",
- "details": [
- {
- "field": "string",
- "value": "string",
- "location": "string",
- "issue": "string"
}
], - "links": [
- {
- "method": "GET",
- "rel": "string",
- "href": "string",
- "title": "string"
}
]
}