| GET | /vehicles/preBootWarnings | Gets pre-boot warnings for a vehicle. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | query | Guid | Yes | The Customer ID. |
| LicenseTag | query | string | Yes | 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Warnings | form | List<PreBootWarning> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No | |
| CollectionAttemptID | form | Guid | No |
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/preBootWarnings HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
warnings:
[
{
message: String,
collectionAttemptID: 00000000000000000000000000000000
}
]
}