The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Items:
[
{
AppointmentId: 00000000000000000000000000000000,
SerialNumber: String,
AppointmentNumber: 0,
RawAppointmentNumber: String,
AppointmentShop: String,
AppointmentAdvisor: String,
AppointmentBookingUser: String,
AppointmentTransportation: String,
AppointmentContactRef: 00000000000000000000000000000000,
AppointmentVehicleRef: 00000000000000000000000000000000,
AppointmentMileageIn: 0,
AppointmentIsComeback: False,
AppointmentIsWaiter: False,
AppointmentTime: 0001-01-01,
AppointmentTimeUTC: 0001-01-01,
AppointmentPickupTime: 0001-01-01,
AppointmentPickupTimeUTC: 0001-01-01,
AppointmentDateOpened: 0001-01-01,
AppointmentRequestLines:
[
{
AppointmentRequestRef: 00000000000000000000000000000000,
AppointmentRequestId: 0,
CSR: String,
CSRRef: 00000000000000000000000000000000,
Skill: String,
RequestCode: String,
RequestDescription: String,
AllowedHours: 0,
EstimateLabour: 0,
EstimateParts: 0,
PartsLines:
[
{
AppointmentPartsLineRef: 00000000000000000000000000000000,
AppointmentPartsLineId: 0,
CSR: String,
CSRRef: 00000000000000000000000000000000,
PartNumber: String,
PartDescription: String,
Requested: 0,
Shipped: 0,
Ordered: 0,
PriceCode: String,
Cost: 0,
UnitPrice: 0,
ExtendedPrice: 0,
NoHistory: False,
IsPartsKit: False,
PartsKitName: String,
BIN: String,
IsTransferred: False
}
],
LabourOpDescription: String,
PayType: String,
Tech: String,
TechRef: 00000000000000000000000000000000,
Status: String,
LineType: RequestLine
}
],
AppointmentLastUpdate: 0001-01-01,
AppointmentStatus: String,
AppointmentNotes: String,
AppointmentSource: String,
AppointmentPendingRequest: False,
AppointmentCheckedIn: False,
AppointmentConfirmed: False,
AppointmentLeadRef: String,
AppointmentNotifyType: String,
AppointmentTag: String,
AppointmentAlternateStartAddress:
{
Name: String,
Address: String,
City: String,
Province: String,
PostalCode: String,
AdditionalInfo: String
},
AppointmentAlternateEndAddress:
{
Name: String,
Address: String,
City: String,
Province: String,
PostalCode: String,
AdditionalInfo: String
},
ContactId: 00000000000000000000000000000000,
ContactCode: String,
ContactLastName: String,
ContactFirstName: String,
ContactSalutation: String,
ContactMiddleName: String,
ContactContactName: String,
ContactIsInactive: False,
ContactIsBusiness: False,
ContactApartmentNumber: String,
ContactAddress: String,
ContactCity: String,
ContactCounty: String,
ContactState: String,
ContactZipCode: String,
ContactBusinessPhone: String,
ContactHomePhone: String,
ContactCellPhone: String,
ContactFaxNumber: String,
ContactEmailAddress: String,
ContactNotes: String,
ContactCriticalMemo: String,
ContactBirthDate: 0001-01-01,
ContactGender: String,
ContactDriverLicense: String,
ContactPreferredContactMethods:
[
String
],
ContactCommunicationPreferences:
{
Email: String,
Phone: String,
TextMessage: String,
Letter: String,
Preferred: String,
FollowUp: String,
Marketing: String,
ThirdParty: String,
ImplicitConsentDate: 0001-01-01
},
ContactSalesRepRef: 00000000000000000000000000000000,
ContactLanguage: String,
VehicleId: 00000000000000000000000000000000,
VehicleStockNumber: String,
VehicleVIN: String,
VehicleLicenseNumber: String,
VehicleFleetNumber: String,
VehicleStatus: String,
VehicleModelNumber: String,
VehicleMake: String,
VehicleModel: String,
VehicleTrim: String,
VehicleType: String,
VehicleYear: String,
VehicleOdometer: 0,
VehicleExteriorColor:
{
Code: String,
Description: String,
BaseColor: String
},
VehicleInteriorColor:
{
Code: String,
Description: String,
BaseColor: String
},
VehicleEngine: String,
VehicleCylinders: String,
VehicleTransmission: String,
VehicleFuel: String,
VehicleInServiceDate: 0001-01-01,
VehicleLastServiceDate: 0001-01-01,
VehicleLastServiceMileage: 0,
VehicleNotes: String,
VehicleCriticalMemo: String
}
]
}