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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetPreBootWarningsForVehicle HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetPreBootWarningsForVehicle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <LicenseState>String</LicenseState>
  <LicenseTag>String</LicenseTag>
  <PlateType>String</PlateType>
</GetPreBootWarningsForVehicle>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PreBootWarningResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Warnings>
    <PreBootWarning>
      <CollectionAttemptID>00000000-0000-0000-0000-000000000000</CollectionAttemptID>
      <Message>String</Message>
    </PreBootWarning>
  </Warnings>
</PreBootWarningResponse>