GET | /eligibility/history/search | Find all the vehicle eligibility history 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. |
DateFrom | query | DateTime | No | The earliest date of eligibility history search. |
DateTo | query | DateTime | No | The most recent date of eligibility history search. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PageIndex | form | int | No | |
PageSize | form | int | No | |
TotalItems | form | int | No | |
Results | form | List<MsEligibilityHistorySearchResultItem> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MsEligibilityHistoryId | form | int | No | |
CustomerId | form | Guid | No | |
CustomerCode | form | string | No | |
VehicleId | form | Guid | No | |
LicenseState | form | string | No | |
LicenseTag | form | string | No | |
EligibilityType | form | int | No | |
IsEligible | form | bool | No | |
Reason | form | string | No | |
UserFriendlyReason | form | string | No | |
Detail | form | string | No | |
DateCreated | form | DateTime | 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 /eligibility/history/search HTTP/1.1 Host: api.paylock.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <MsEligibilityHistorySearchResult 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> <MsEligibilityHistorySearchResultItem> <CustomerCode>String</CustomerCode> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <DateCreated>0001-01-01T00:00:00</DateCreated> <Detail>String</Detail> <EligibilityType>0</EligibilityType> <IsEligible>false</IsEligible> <LicenseState>String</LicenseState> <LicenseTag>String</LicenseTag> <MsEligibilityHistoryId>0</MsEligibilityHistoryId> <Reason>String</Reason> <UserFriendlyReason>String</UserFriendlyReason> <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId> </MsEligibilityHistorySearchResultItem> </Results> <TotalItems>0</TotalItems> </MsEligibilityHistorySearchResult>