BootView WebApi

<back to all web services

GetPreBootWarningsForVehicle

The following routes are available for this service:
GET/vehicles/preBootWarningsGets pre-boot warnings for a vehicle.
GetPreBootWarningsForVehicle Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidYesThe Customer ID.
LicenseTagquerystringYesThe plate number.
LicenseStatequerystringNoThe state the plate is from.
PlateTypequerystringNoThe plate type (e.g. Commercial or Motorcycle. Specific to each municipality.
PreBootWarningResponse Parameters:
NameParameterData TypeRequiredDescription
WarningsformList<PreBootWarning>No
PreBootWarning Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
CollectionAttemptIDformGuidNo

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

{
	customerId: 00000000000000000000000000000000,
	licenseTag: String,
	licenseState: String,
	plateType: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	warnings: 
	[
		{
			message: String,
			collectionAttemptID: 00000000000000000000000000000000
		}
	]
}