BootView WebApi

GetCommonEligibility

The following routes are available for this service:
GET	/commoneligibilityresult/getcommoneligibility	Returns whether or not the vehicle has been booted recently.

**GetCommonEligibility** Parameters:
Name	Parameter	Data Type	Required	Description
EligibilityType	query	CommonEligibilityType	Yes	The eligibility type to check (Notice\|Boot\|Tow).
CustomerId	query	Guid	Yes	The Customer Id.
LicenseTag	query	string	Yes	The license tag.
LicenseState	query	string	No	The license state.
PlateType	query	string	No	The plate type.

**CommonEligibilityType** Enum:
Unspecified
Notice
Boot
Tow

**CommonEligibilityResult** Parameters:
Name	Parameter	Data Type	Required
PlateOfInterest	form	CommonEligiblePlate	No
BootRecordCount	form	int	No
IsTowable	form	bool	No
IsRunaway	form	bool	No
NetDue	form	decimal	No
CustomerBootFee	form	decimal	No
CustomerOtherFees	form	decimal	No
TotalAmountDue	form	decimal	No
Bills	form	List<CommonEligibleBill>	No
ReasonsDisplay	form	string	No
IsStolen	form	bool	No
IsReleasedWithoutPayment	form	bool	No
IsBootedRecently	form	bool	No
IsBootEligible	form	bool	No
IsNoticeEligible	form	bool	No
BillsByPlate	form	Dictionary<string, List<CommonEligibleBill>>	No

**CommonEligiblePlate** Parameters:
Name	Parameter	Data Type	Required
LicenseTag	form	string	No
LicenseState	form	string	No
PlateType	form	string	No
VIN	form	string	No
Id	form	Guid	No
MakeModel	form	string	No
Color	form	string	No
RegisteredName	form	string	No
RegisteredAddress	form	Dictionary<string, string>	No

**CommonEligibleBill** Parameters:
Name	Parameter	Data Type	Required
BillId	form	Guid	No
ReferenceId	form	string	No
CustomerAccountNumber	form	string	No
OriginalAmountDue	form	decimal	No
NetDue	form	decimal	No
Plate	form	CommonEligiblePlate	No
BillType	form	BillCategory	No
BillTypeDisplay	form	string	No
DateDue	form	DateTime	No
EligibilityIsApplicable	form	bool	No
IsNoticeEligible	form	bool	No
IsBootEligible	form	bool	No
IsTowEligible	form	bool	No

**BillCategory** Enum:
None
PaylockFee
BootFee
ParkingFine
Tax
TowFee
ImpoundFee
LateBootFee
DamagedBootFee
LostBootFee
ReturnedCheckFee
NoticeFee
PropertyTax
RedLightTicket
ConvenienceFee
SecurityFee
AdministrativeFee
BootReleaseFee
Poundage
ExecutionFee
SalesTax
MarshalExpense
CityDecal
SpeedingFine
TowDispatchFee
Miscellaneous
Affiliated
TpvaCCFee
HandicappedParkingFine
PaylockPlanServiceFee
AdditionalFine
OverheadTruck

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 /commoneligibilityresult/getcommoneligibility HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

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>
  <CustomerBootFee>0</CustomerBootFee>
  <CustomerOtherFees>0</CustomerOtherFees>
  <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>