BootView WebApi

<back to all web services

GetMsEligibilityHistory

The following routes are available for this service:
GET/eligibility/history/searchFind all the vehicle eligibility history that meet the search criteria
GetMsEligibilityHistory Parameters:
NameParameterData TypeRequiredDescription
CustomerIdqueryGuidNoThe customer Id for which we want the vehicles.
LicenseTagquerystringNoThe license tag.
LicenseStatequerystringNoThe license state.
CarMakeModelquerystringNoThe car make and model.
CarColorquerystringNoThe car color.
FirstNamequerystringNoThe first name.
LastNamequerystringNoThe last name.
ZipcodequerystringNoThe zipcode.
Address1querystringNoFirst line of address.
Address2querystringNoSecond line of address.
StickerIdquerystringNoThe sticker Id.
SortFieldquerystringNoThe sort field.
PageIndexqueryintNoThe page index.
PageSizequeryintNoNumber of results to return per page.
IsNameSearchqueryboolNoWhether this is a name search.
CollectionAttemptIdqueryGuidNoFor a Name Search, the Collection Attempt Id for the attempt that initiated the search.
DateFromqueryDateTimeNoThe earliest date of eligibility history search.
DateToqueryDateTimeNoThe most recent date of eligibility history search.
MsEligibilityHistorySearchResult Parameters:
NameParameterData TypeRequiredDescription
PageIndexformintNo
PageSizeformintNo
TotalItemsformintNo
ResultsformList<MsEligibilityHistorySearchResultItem>No
MsEligibilityHistorySearchResultItem Parameters:
NameParameterData TypeRequiredDescription
MsEligibilityHistoryIdformintNo
CustomerIdformGuidNo
CustomerCodeformstringNo
VehicleIdformGuidNo
LicenseStateformstringNo
LicenseTagformstringNo
EligibilityTypeformintNo
IsEligibleformboolNo
ReasonformstringNo
UserFriendlyReasonformstringNo
DetailformstringNo
DateCreatedformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>