GET | /collectionattempts/{attemptId}/vehicle | Get the vehicle related to this attempt (the vehicle booted, towed, or noticed). |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AttemptId | path | Guid | Yes | The collection attempt id for which we want the vehicle. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
LicenseTag | form | string | No | |
LicenseState | form | string | No | |
MakeModel | form | string | No | |
Color | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
AddressStreet1 | form | string | No | |
AddressStreet2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
CreatedByUserId | form | Guid? | No | |
DateCreated | form | DateTime? | No | |
PlateType | form | string | No | |
Nixie | form | bool? | No | |
NoHit | form | bool? | No | |
VIN | form | string | No | |
IsStolen | form | bool? | 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 /collectionattempts/{attemptId}/vehicle HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 }