PartnerHub

<back to all web services

AppointmentGet

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/AppointmentGet HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: text/jsv
Content-Length: length

{
	SerialNumber: String,
	AppointmentId: 00000000000000000000000000000000,
	AppointmentNumber: 0,
	RawAppointmentNumber: String,
	ContactRef: 00000000000000000000000000000000,
	VehicleRef: 00000000000000000000000000000000,
	Status: String,
	AppointmentSince: 0001-01-01,
	AppointmentUntil: 0001-01-01,
	ModifiedSince: 0001-01-01,
	ModifiedUntil: 0001-01-01,
	Shop: String,
	AppointmentNumberList: 
	[
		0
	],
	RawAppointmentNumberList: 
	[
		String
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Appointments: 
	[
		{
			Id: string/00000000-0000-0000-0000-000000000000,
			AppointmentId: 00000000000000000000000000000000,
			SerialNumber: String,
			AppointmentNumber: 0,
			RawAppointmentNumber: String,
			Shop: String,
			Advisor: String,
			AdvisorRef: 00000000000000000000000000000000,
			BookingUser: String,
			BookingUserRef: 00000000000000000000000000000000,
			Transportation: String,
			ContactRef: 00000000000000000000000000000000,
			VehicleRef: 00000000000000000000000000000000,
			MileageIn: 0,
			IsComeback: False,
			IsWaiter: False,
			AppointmentTime: 0001-01-01,
			AppointmentTimeUTC: 0001-01-01,
			PickupTime: 0001-01-01,
			PickupTimeUTC: 0001-01-01,
			RequestLines: 
			[
				{
					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
				}
			],
			DateOpened: 0001-01-01,
			LastUpdate: 0001-01-01,
			Status: String,
			Notes: String,
			Source: String,
			PendingRequest: False,
			CheckedIn: False,
			Confirmed: False,
			LeadRef: String,
			NotifyType: String,
			Tag: String,
			FirstApptTimeAvailable: 0001-01-01T00:00:00.0000000+00:00
		}
	]
}