| GET | /vehicles/search | Find all the vehicle records that meet the search criteria |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | query | Guid | No | The customer Id for which we want the vehicles. |
| LicenseTag | query | string | No | The license tag. |
| LicenseState | query | string | No | The license state. |
| CarMakeModel | query | string | No | The car make and model. |
| CarColor | query | string | No | The car color. |
| FirstName | query | string | No | The first name. |
| LastName | query | string | No | The last name. |
| Zipcode | query | string | No | The zipcode. |
| Address1 | query | string | No | First line of address. |
| Address2 | query | string | No | Second line of address. |
| StickerId | query | string | No | The sticker Id. |
| SortField | query | string | No | The sort field. |
| PageIndex | query | int | No | The page index. |
| PageSize | query | int | No | Number of results to return per page. |
| IsNameSearch | query | bool | No | Whether this is a name search. |
| CollectionAttemptId | query | Guid | No | For a Name Search, the Collection Attempt Id for the attempt that initiated the search. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PageIndex | form | int | No | |
| PageSize | form | int | No | |
| TotalItems | form | int | No | |
| Results | form | List<VehicleSearchResultItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionAttemptId | form | Guid | No | |
| StickerId | form | string | No | |
| CustomerCode | form | string | No | |
| VehicleId | form | Guid | No | |
| LicenseState | form | string | No | |
| LicenseTag | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| AddressStreet1 | form | string | No | |
| Zip | form | string | No | |
| CarMakeModel | form | string | No | |
| CarColor | form | string | No | |
| CustomerId | form | Guid | No | |
| Phonenumber | form | string | No | |
| AmountOutstanding | form | decimal | No | |
| IsMergeCandidate | form | bool | No | |
| IsUnMergeCandidate | 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 /vehicles/search HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
pageIndex: 0,
pageSize: 0,
totalItems: 0,
results:
[
{
collectionAttemptId: 00000000000000000000000000000000,
stickerId: String,
customerCode: String,
vehicleId: 00000000000000000000000000000000,
licenseState: String,
licenseTag: String,
firstName: String,
lastName: String,
addressStreet1: String,
zip: String,
carMakeModel: String,
carColor: String,
customerId: 00000000000000000000000000000000,
phonenumber: String,
amountOutstanding: 0,
isMergeCandidate: False,
isUnMergeCandidate: False
}
]
}