PartnerHub

<back to all web services

UPGet

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

{
	SerialNumber: String,
	UPId: 00000000000000000000000000000000,
	ContactRef: 00000000000000000000000000000000,
	ProspectRef: 00000000000000000000000000000000,
	AssignedEmployeeRef: 00000000000000000000000000000000,
	UPStatus: 0,
	LeadRef: String,
	EmailAddress: String,
	FirstName: String,
	LastName: String,
	ModifiedSince: 0001-01-01,
	ModifiedUntil: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UPs: 
	[
		{
			Id: string/00000000-0000-0000-0000-000000000000,
			UPId: 00000000000000000000000000000000,
			SerialNumber: String,
			ProspectId: 00000000000000000000000000000000,
			DateCreated: 0001-01-01,
			Notes: String,
			CreatedUserRef: 00000000000000000000000000000000,
			AssignedUserRef: 0,
			AssignedEmployeeRef: 00000000000000000000000000000000,
			AssignedUserName: String,
			IntegrationType: 0,
			IntegrationId: 00000000000000000000000000000000,
			Source: 0,
			SourceDesc: String,
			Status: 0,
			StatusDesc: String,
			ContactTitle: String,
			FirstName: String,
			MiddleName: String,
			LastName: String,
			LanguagePreference: String,
			HomePhone: String,
			CellPhone: String,
			BusinessPhone: String,
			Email: String,
			Address: String,
			City: String,
			State: String,
			ZIP: String,
			LeadId: String,
			ThirdPartySourceRef: 00000000000000000000000000000000,
			ProspectSourceRef: 00000000000000000000000000000000,
			ProspectSource: String,
			AutoReplyDate: 0001-01-01,
			ManualReplyDate: 0001-01-01,
			ImportedDate: 0001-01-01,
			AssignedDate: 0001-01-01,
			ParentRef: 00000000000000000000000000000000,
			LeadSource: 0,
			LeadSourceDesc: String,
			Interests: 
			[
				{
					StockNumber: String,
					VIN: String,
					Year: String,
					Make: String,
					Model: String,
					Odometer: String,
					Options: String,
					Trim: String,
					InterestType: String,
					Notes: String
				}
			],
			Trades: 
			[
				{
					StockNumber: String,
					VIN: String,
					Year: String,
					Make: String,
					Model: String,
					Odometer: String,
					Options: String,
					Trim: String,
					InterestType: String,
					Notes: String
				}
			],
			LastUpdate: 0001-01-01,
			CustomFields: 
			[
				{
					Key: String,
					Value: String,
					Type: String
				}
			]
		}
	]
}