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 .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/search HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <VehicleSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <PageIndex>0</PageIndex> <PageSize>0</PageSize> <Results> <VehicleSearchResultItem> <AddressStreet1>String</AddressStreet1> <AmountOutstanding>0</AmountOutstanding> <CarColor>String</CarColor> <CarMakeModel>String</CarMakeModel> <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId> <CustomerCode>String</CustomerCode> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <FirstName>String</FirstName> <IsMergeCandidate>false</IsMergeCandidate> <IsUnMergeCandidate>false</IsUnMergeCandidate> <LastName>String</LastName> <LicenseState>String</LicenseState> <LicenseTag>String</LicenseTag> <Phonenumber>String</Phonenumber> <StickerId>String</StickerId> <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId> <Zip>String</Zip> </VehicleSearchResultItem> </Results> <TotalItems>0</TotalItems> </VehicleSearchResult>