This end-point fetches an item, for a dealer, which are required at the time of appointment checkin. Eg- A dealer could ask customer to submit items like insurance and credit card prior to checkin.
Item could be any document which is required for the customer to sign and send back to the dealer, it could be a video or images of vehicle which dealer requires before checkin or could be anything(like VIN) which dealer wants the customer to scan.
ApiScope: manage.dealer.supported.item.read
API Scope Level: DealerScope
Path Parameters
supportedItemUuid string required
ServiceSubscriberDealer string required
Responses
- 200
- 400
- 401
- 403
- 500
OK
application/json
application/x-protobuf
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
dealerSupportedItem object
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"dealerSupportedItem": {
"id": 0,
"uuid": "string",
"type": "string",
"name": "string",
"action": "string",
"description": "string",
"dealerUuid": "string",
"required": true,
"approvalNeeded": true,
"maintainHistory": true,
"vaultSupportedDataUuid": "string",
"isValid": true,
"dealerAssociatesWithApprovalAuthority": [
{
"userUuid": "string",
"departmentUuid": "string",
"dealerSupportedItemUuid": "string",
"isValid": true
}
],
"dealerSupportedItemMetaData": {
"dealerSupportedItemUuid": "string",
"fileText": "string",
"fileUrl": "string"
},
"isBackPageSupported": true
}
}
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
dealerSupportedItem object
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"dealerSupportedItem": {
"id": 0,
"uuid": "string",
"type": "string",
"name": "string",
"action": "string",
"description": "string",
"dealerUuid": "string",
"required": true,
"approvalNeeded": true,
"maintainHistory": true,
"vaultSupportedDataUuid": "string",
"isValid": true,
"dealerAssociatesWithApprovalAuthority": [
{
"userUuid": "string",
"departmentUuid": "string",
"dealerSupportedItemUuid": "string",
"isValid": true
}
],
"dealerSupportedItemMetaData": {
"dealerSupportedItemUuid": "string",
"fileText": "string",
"fileUrl": "string"
},
"isBackPageSupported": true
}
}
Bad Request
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Unauthorized
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Forbidden
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
Internal Server Error
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
GET /v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid
Authorization
name: basicAuthtype: httpscheme: basic
Request
Request
curl / cURL
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
python / requests
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
go / native
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET '/manage/v2/dealer/:ServiceSubscriberDealer/supportedItem/:supportedItemUuid' \
-H 'Accept: application/json'