PartnerHub

<back to all web services

ProspectGet

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/ProspectGet HTTP/1.1 
Host: partnerhub.pbsdealers.com 
Content-Type: text/jsv
Content-Length: length

{
	SerialNumber: String,
	ProspectId: 00000000000000000000000000000000,
	ContactRef: 00000000000000000000000000000000,
	EmployeeRef: 00000000000000000000000000000000,
	ProspectStatus: String,
	ProspectType: String,
	ProspectSource: String,
	VehicleType: String,
	ClosedSince: 0001-01-01,
	ClosedUntil: 0001-01-01,
	ModifiedSince: 0001-01-01,
	ModifiedUntil: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Prospects: 
	[
		{
			Id: string/00000000-0000-0000-0000-000000000000,
			ProspectId: 00000000000000000000000000000000,
			SerialNumber: String,
			DateOpened: 0001-01-01,
			DateClosed: 0001-01-01,
			ContactRef: 00000000000000000000000000000000,
			UserRoles: 
			[
				{
					EmployeeRef: 00000000000000000000000000000000,
					Name: String,
					Role: String
				}
			],
			ProspectStatus: String,
			ProspectType: String,
			ProspectSource: String,
			VehicleType: String,
			VehicleYearFrom: String,
			VehicleYearTo: String,
			VehicleModelNumber: String,
			VehicleMake: String,
			VehicleModel: String,
			VehicleTrim: String,
			LastUpdate: 0001-01-01,
			ProspectState: String,
			LastEventDate: 0001-01-01,
			EmployeeRef: 00000000000000000000000000000000
		}
	]
}