BootView WebApi

<back to all web services

GetCommonEligibility

The following routes are available for this service:
GET/commoneligibilityresult/getcommoneligibilityReturns whether or not the vehicle has been booted recently.
GetCommonEligibility Parameters:
NameParameterData TypeRequiredDescription
EligibilityTypequeryCommonEligibilityTypeYesThe eligibility type to check (Notice|Boot|Tow).
CustomerIdqueryGuidYesThe Customer Id.
LicenseTagquerystringYesThe license tag.
LicenseStatequerystringNoThe license state.
PlateTypequerystringNoThe plate type.
CommonEligibilityResult Parameters:
NameParameterData TypeRequiredDescription
PlateOfInterestformCommonEligiblePlateNo
BootRecordCountformintNo
IsTowableformboolNo
IsRunawayformboolNo
NetDueformdecimalNo
BillsformList<CommonEligibleBill>No
ReasonsDisplayformstringNo
IsStolenformboolNo
IsReleasedWithoutPaymentformboolNo
IsBootedRecentlyformboolNo
IsBootEligibleformboolNo
IsNoticeEligibleformboolNo
BillsByPlateformDictionary<string, List<CommonEligibleBill>>No
CommonEligiblePlate Parameters:
NameParameterData TypeRequiredDescription
LicenseTagformstringNo
LicenseStateformstringNo
PlateTypeformstringNo
VINformstringNo
IdformGuidNo
MakeModelformstringNo
ColorformstringNo
RegisteredNameformstringNo
RegisteredAddressformDictionary<string, string>No
CommonEligibleBill Parameters:
NameParameterData TypeRequiredDescription
BillIdformGuidNo
ReferenceIdformstringNo
CustomerAccountNumberformstringNo
OriginalAmountDueformdecimalNo
NetDueformdecimalNo
PlateformCommonEligiblePlateNo
BillTypeformBillCategoryNo
BillTypeDisplayformstringNo
DateDueformDateTimeNo
EligibilityIsApplicableformboolNo
IsNoticeEligibleformboolNo
IsBootEligibleformboolNo
IsTowEligibleformboolNo

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.

POST /xml/reply/GetCommonEligibility HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetCommonEligibility xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <EligibilityType>Unspecified</EligibilityType>
  <LicenseState>String</LicenseState>
  <LicenseTag>String</LicenseTag>
  <PlateType>String</PlateType>
</GetCommonEligibility>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommonEligibilityResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Bills>
    <CommonEligibleBill>
      <BillId>00000000-0000-0000-0000-000000000000</BillId>
      <BillType>None</BillType>
      <BillTypeDisplay>String</BillTypeDisplay>
      <CustomerAccountNumber>String</CustomerAccountNumber>
      <DateDue>0001-01-01T00:00:00</DateDue>
      <EligibilityIsApplicable>false</EligibilityIsApplicable>
      <IsBootEligible>false</IsBootEligible>
      <IsNoticeEligible>false</IsNoticeEligible>
      <IsTowEligible>false</IsTowEligible>
      <NetDue>0</NetDue>
      <OriginalAmountDue>0</OriginalAmountDue>
      <Plate>
        <Color>String</Color>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <LicenseState>String</LicenseState>
        <LicenseTag>String</LicenseTag>
        <MakeModel>String</MakeModel>
        <PlateType>String</PlateType>
        <RegisteredAddress xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </RegisteredAddress>
        <RegisteredName>String</RegisteredName>
        <VIN>String</VIN>
      </Plate>
      <ReferenceId>String</ReferenceId>
    </CommonEligibleBill>
  </Bills>
  <BillsByPlate xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfCommonEligibleBillJ6BLtwWK>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <CommonEligibleBill>
          <BillId>00000000-0000-0000-0000-000000000000</BillId>
          <BillType>None</BillType>
          <BillTypeDisplay>String</BillTypeDisplay>
          <CustomerAccountNumber>String</CustomerAccountNumber>
          <DateDue>0001-01-01T00:00:00</DateDue>
          <EligibilityIsApplicable>false</EligibilityIsApplicable>
          <IsBootEligible>false</IsBootEligible>
          <IsNoticeEligible>false</IsNoticeEligible>
          <IsTowEligible>false</IsTowEligible>
          <NetDue>0</NetDue>
          <OriginalAmountDue>0</OriginalAmountDue>
          <Plate>
            <Color>String</Color>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <LicenseState>String</LicenseState>
            <LicenseTag>String</LicenseTag>
            <MakeModel>String</MakeModel>
            <PlateType>String</PlateType>
            <RegisteredAddress>
              <d2p1:KeyValueOfstringstring>
                <d2p1:Key>String</d2p1:Key>
                <d2p1:Value>String</d2p1:Value>
              </d2p1:KeyValueOfstringstring>
            </RegisteredAddress>
            <RegisteredName>String</RegisteredName>
            <VIN>String</VIN>
          </Plate>
          <ReferenceId>String</ReferenceId>
        </CommonEligibleBill>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfCommonEligibleBillJ6BLtwWK>
  </BillsByPlate>
  <BootRecordCount>0</BootRecordCount>
  <IsBootEligible>false</IsBootEligible>
  <IsBootedRecently>false</IsBootedRecently>
  <IsNoticeEligible>false</IsNoticeEligible>
  <IsReleasedWithoutPayment>false</IsReleasedWithoutPayment>
  <IsRunaway>false</IsRunaway>
  <IsStolen>false</IsStolen>
  <IsTowable>false</IsTowable>
  <NetDue>0</NetDue>
  <PlateOfInterest>
    <Color>String</Color>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <LicenseState>String</LicenseState>
    <LicenseTag>String</LicenseTag>
    <MakeModel>String</MakeModel>
    <PlateType>String</PlateType>
    <RegisteredAddress xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </RegisteredAddress>
    <RegisteredName>String</RegisteredName>
    <VIN>String</VIN>
  </PlateOfInterest>
  <ReasonsDisplay>String</ReasonsDisplay>
</CommonEligibilityResult>