| 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 .jsv suffix or ?format=jsv
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: text/jsv
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
}
]