BootView WebApi

<back to all web services

GetCollectionAttemptVehicle

The following routes are available for this service:
GET/collectionattempts/{attemptId}/vehicleGet the vehicle related to this attempt (the vehicle booted, towed, or noticed).
GetCollectionAttemptVehicle Parameters:
NameParameterData TypeRequiredDescription
AttemptIdpathGuidYesThe collection attempt id for which we want the vehicle.
CollectionAttemptVehicle Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LicenseTagformstringNo
LicenseStateformstringNo
MakeModelformstringNo
ColorformstringNo
FirstNameformstringNo
LastNameformstringNo
AddressStreet1formstringNo
AddressStreet2formstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
CreatedByUserIdformGuid?No
DateCreatedformDateTime?No
PlateTypeformstringNo
Nixieformbool?No
NoHitformbool?No
VINformstringNo
IsStolenformbool?No

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/GetCollectionAttemptVehicle HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	attemptId: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 00000000000000000000000000000000,
	licenseTag: String,
	licenseState: String,
	makeModel: String,
	color: String,
	firstName: String,
	lastName: String,
	addressStreet1: String,
	addressStreet2: String,
	city: String,
	state: String,
	zip: String,
	createdByUserId: 00000000000000000000000000000000,
	dateCreated: 0001-01-01,
	plateType: String,
	nixie: False,
	noHit: False,
	vin: String,
	isStolen: False
}