GET | /vehicles | Gets a list of vehicles which match the given criteria. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LicenseTag | query | string | No | The plate number. |
LicenseState | query | string | No | The state the plate is from. |
PlateType | query | string | No | The plate type (e.g. Commercial or Motorcycle. Specific to each municipality. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /vehicles HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfVehicle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <Vehicle> <AddressStreet1>String</AddressStreet1> <AddressStreet2>String</AddressStreet2> <City>String</City> <Color>String</Color> <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId> <DateCreated>0001-01-01T00:00:00</DateCreated> <FirstName>String</FirstName> <Id>00000000-0000-0000-0000-000000000000</Id> <IsStolen>false</IsStolen> <LastName>String</LastName> <LicenseState>String</LicenseState> <LicenseTag>String</LicenseTag> <MakeModel>String</MakeModel> <Nixie>false</Nixie> <NoHit>false</NoHit> <PlateType>String</PlateType> <State>String</State> <VIN>String</VIN> <Zip>String</Zip> </Vehicle> </ArrayOfVehicle>