PartnerHub

<back to all web services

ContactGet

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

{
	SerialNumber: String,
	ContactId: 00000000000000000000000000000000,
	ContactCode: String,
	FirstName: String,
	LastName: String,
	PhoneNumber: String,
	EmailAddress: String,
	ModifiedSince: 0001-01-01,
	ModifiedUntil: 0001-01-01,
	CreatedSince: 0001-01-01,
	CreatedUntil: 0001-01-01,
	ContactIdList: 
	[
		00000000000000000000000000000000
	],
	IncludeInactive: False,
	PayableAccount: String,
	ReceivableAccount: String,
	IsAPVendor: False,
	IsARCustomer: False,
	DriverLicense: String,
	ZipCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Contacts: 
	[
		{
			Id: string/00000000-0000-0000-0000-000000000000,
			ContactId: 00000000000000000000000000000000,
			SerialNumber: String,
			Code: String,
			LastName: String,
			FirstName: String,
			Salutation: String,
			MiddleName: String,
			ContactName: String,
			IsInactive: False,
			IsBusiness: False,
			ApartmentNumber: String,
			Address: String,
			City: String,
			County: String,
			State: String,
			ZipCode: String,
			BusinessPhone: String,
			BusinessPhoneExt: String,
			HomePhone: String,
			CellPhone: String,
			BusinessPhoneRawReverse: String,
			HomePhoneRawReverse: String,
			CellPhoneRawReverse: String,
			FaxNumber: String,
			EmailAddress: String,
			Notes: String,
			CriticalMemo: String,
			BirthDate: 0001-01-01,
			Gender: String,
			DriverLicense: String,
			DriversLicenseExpiry: 0001-01-01,
			PreferredContactMethods: 
			[
				String
			],
			LastUpdate: 0001-01-01,
			CustomFields: 
			[
				{
					Key: String,
					Value: String,
					Type: String
				}
			],
			FleetType: String,
			RelationshipType: String,
			CommunicationPreferences: 
			{
				Email: String,
				Phone: String,
				TextMessage: String,
				Letter: String,
				Preferred: String,
				FollowUp: String,
				Marketing: String,
				ThirdParty: String,
				ImplicitConsentDate: 0001-01-01
			},
			SalesRepRef: 00000000000000000000000000000000,
			Language: String,
			PayableAccount: String,
			ReceivableAccount: String,
			IsStatic: False,
			PrimaryImageRef: 00000000000000000000000000000000,
			PayableAccounts: 
			[
				{
					SerialNumber: String,
					Account: String
				}
			],
			ReceivableAccounts: 
			[
				{
					SerialNumber: String,
					Account: String
				}
			],
			IsAPVendor: False,
			IsARCustomer: False,
			ManufacturerLoyaltyNumber: String,
			MergedToContactRef: 00000000000000000000000000000000,
			DoNotLoadHistory: False,
			RepairOrderRequiresPO: False,
			CreatedDate: 0001-01-01,
			SalesReps: 
			[
				{
					SerialNumber: String,
					SalesRepRef: 00000000000000000000000000000000
				}
			]
		}
	]
}