BootView WebApi

<back to all web services

GetSearchVehicles

The following routes are available for this service:
GET/vehicles/searchFind all the vehicle records that meet the search criteria
GetSearchVehicles Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the vehicles.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
FirstNamequerystringNoThe first name.
LastNamequerystringNoThe last name.
ZipcodequerystringNoThe zipcode.
Address1querystringNoFirst line of address.
Address2querystringNoSecond line of address.
StickerIdquerystringNoThe sticker Id.
SortFieldquerystringNoThe sort field.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return per page.
IsNameSearchqueryboolNoWhether this is a name search.
CollectionAttemptIdqueryGuidNoFor a Name Search, the Collection Attempt Id for the attempt that initiated the search.
VehicleSearchResult Parameters:
NameParameterData TypeRequiredDescription
PageIndexformintNo
PageSizeformintNo
TotalItemsformintNo
ResultsformList<VehicleSearchResultItem>No
VehicleSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdformGuidNo
StickerIdformstringNo
CustomerCodeformstringNo
VehicleIdformGuidNo
LicenseStateformstringNo
LicenseTagformstringNo
FirstNameformstringNo
LastNameformstringNo
AddressStreet1formstringNo
ZipformstringNo
CarMakeModelformstringNo
CarColorformstringNo
CustomerIdformGuidNo
PhonenumberformstringNo
AmountOutstandingformdecimalNo
IsMergeCandidateformboolNo
IsUnMergeCandidateformboolNo

To override the Content-type in your clients, use the 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/GetSearchVehicles HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	customerId: 00000000000000000000000000000000,
	licenseTag: String,
	licenseState: String,
	carMakeModel: String,
	carColor: String,
	firstName: String,
	lastName: String,
	zipcode: String,
	address1: String,
	address2: String,
	stickerId: String,
	sortField: String,
	pageIndex: 0,
	pageSize: 0,
	isNameSearch: False,
	collectionAttemptId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	pageIndex: 0,
	pageSize: 0,
	totalItems: 0,
	results: 
	[
		{
			collectionAttemptId: 00000000000000000000000000000000,
			stickerId: String,
			customerCode: String,
			vehicleId: 00000000000000000000000000000000,
			licenseState: String,
			licenseTag: String,
			firstName: String,
			lastName: String,
			addressStreet1: String,
			zip: String,
			carMakeModel: String,
			carColor: String,
			customerId: 00000000000000000000000000000000,
			phonenumber: String,
			amountOutstanding: 0,
			isMergeCandidate: False,
			isUnMergeCandidate: False
		}
	]
}