getAppointment
getAppointment
Header Parameters
authorization string required
application/json
Request Body required
requesterUserUuid string
dealerDepartmentUuidList string[]
appointmentUUID string
appointmentKey string
dealerUuid string
Responses
- 200
- 204
- 208
- 400
- 401
- 403
- 409
- 500
OK
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
serviceAppointment object
uuid string
preferredDate string
platform string
Possible values: [DEALER_APP, WEB, MOBILE_APP, DMS, TRANSPORTATION_EVENTS_CONSUMER]
serviceStartTime string
serviceEndTime string
dealerUUID string
customerUUID string
status string
Possible values: [PENDING_APPROVAL, SCHEDULED, TRIP_IN_PROGRESS, TECHNICIAN_ARRIVED, SERVICE_IN_PROGRESS, SERVICE_COMPLETED, CANCELLED, COMPLETED, DECLINED]
appointmentType string
Possible values: [MOBILE_SERVICE, REGULAR_SERVICE]
publicNotes string
internalNotes string
customerVehicleUUID string
sprinterVehicleUUID string
lastMileage string
textPreference boolean
emailPreference boolean
assignedUser object
userUuid string
departmentUuid string
isValid boolean
isMobileServiceTechnician boolean
createdByUser object
userUuid string
departmentUuid string
isValid boolean
isMobileServiceTechnician boolean
serviceAdvisor object
userUuid string
departmentUuid string
isValid boolean
isMobileServiceTechnician boolean
destinationAddress string
destinationLatitude double
destinationLongitude double
quickOpList object[]
quickOpLiteUUID string
description string
opCodeDuration string
laborOpCode string
opCodeName string
totalPrice string
appointmentKey string
createdTimeStamp date-time
prospectUuid string
contactDate string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
],
"serviceAppointment": {
"uuid": "string",
"preferredDate": "string",
"platform": "DEALER_APP",
"serviceStartTime": "string",
"serviceEndTime": "string",
"dealerUUID": "string",
"customerUUID": "string",
"status": "PENDING_APPROVAL",
"appointmentType": "MOBILE_SERVICE",
"publicNotes": "string",
"internalNotes": "string",
"customerVehicleUUID": "string",
"sprinterVehicleUUID": "string",
"lastMileage": "string",
"textPreference": true,
"emailPreference": true,
"assignedUser": {
"userUuid": "string",
"departmentUuid": "string",
"isValid": true,
"isMobileServiceTechnician": true
},
"createdByUser": {
"userUuid": "string",
"departmentUuid": "string",
"isValid": true,
"isMobileServiceTechnician": true
},
"serviceAdvisor": {
"userUuid": "string",
"departmentUuid": "string",
"isValid": true,
"isMobileServiceTechnician": true
},
"destinationAddress": "string",
"destinationLatitude": 0,
"destinationLongitude": 0,
"quickOpList": [
{
"quickOpLiteUUID": "string",
"description": "string",
"opCodeDuration": "string",
"laborOpCode": "string",
"opCodeName": "string",
"totalPrice": "string"
}
],
"appointmentKey": "string",
"createdTimeStamp": "2026-05-28T14:02:48.844Z",
"prospectUuid": "string",
"contactDate": "string"
}
}
No Content
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Already Reported
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Bad Request
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Unauthorized
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Forbidden
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Conflict
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Internal Server Error
*/*
Schema
Example (from schema)
Schema
- Array [
- ]
statusCode int32
error object
code string
description string
metadata object
property name* string
warnings object[]
code string
description string
{
"statusCode": 0,
"error": {
"code": "string",
"description": "string",
"metadata": {}
},
"warnings": [
{
"code": "string",
"description": "string"
}
]
}
Loading...