BootView WebApi

GetReleaseEligibility

The following routes are available for this service:
GET	/releaseeligibility/{id}	Gets the release eligibility status of a given Boot Collection Attempt.

**GetReleaseEligibility** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	Guid	Yes	The unique boot collection attempt Id.
Type	query	EligibilityType	No	SelfRelease \| AssistedRelease. Defaults to SelfRelease if not provided.

**EligibilityType** Enum:
Unkown
Notice
Boot
Tow
SelfRelease
AssistedRelease

**CustomerPolicyResult** Parameters:
Name	Parameter	Data Type	Required
Aggregator	form	EligibilityRuleSetAggregator	No
IsEligible	form	bool	No
Override	form	PolicyOverride	No
RuleResults	form	List<RuleResult>	No
RuleSetResults	form	List<CustomerPolicyResult>	No

**EligibilityRuleSetAggregator** Enum:
Unknown
All
Any
None

**PolicyOverride** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CollectionAttemptId	form	Guid	No
DateCreated	form	DateTime	No
EligibilityType	form	EligibilityType	No
OverrideReasonId	form	int	No
PolicyId	form	int	No
ShouldPass	form	bool	No
UserId	form	Guid	No

**RuleResult** Parameters:
Name	Parameter	Data Type	Required	Description
Rule	form	Rule	No
IsEligible	form	bool	No

**Rule** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
RuleType	form	string	No
RuleData	form	RuleData	No

**RuleData** Parameters:
Name	Parameter	Data Type	Required
AlertTypeId	form	int?	No
AmountDueThreshold	form	decimal?	No
AmountPaidThreshold	form	decimal?	No
BillTypeId	form	int?	No
DocumentProofTypeId	form	int?	No
RuleTypeId	form	int	No
RuleSetId	form	int	No
LicenseState	form	string	No

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 /releaseeligibility/{id} HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerPolicyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Aggregator>Unknown</Aggregator>
  <IsEligible>false</IsEligible>
  <Override>
    <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <EligibilityType>Unkown</EligibilityType>
    <Id>0</Id>
    <OverrideReasonId>0</OverrideReasonId>
    <PolicyId>0</PolicyId>
    <ShouldPass>false</ShouldPass>
    <UserId>00000000-0000-0000-0000-000000000000</UserId>
  </Override>
  <RuleResults>
    <RuleResult>
      <IsEligible>false</IsEligible>
      <Rule>
        <Description>String</Description>
        <Id>0</Id>
        <RuleData>
          <AlertTypeId>0</AlertTypeId>
          <AmountDueThreshold>0</AmountDueThreshold>
          <AmountPaidThreshold>0</AmountPaidThreshold>
          <BillTypeId>0</BillTypeId>
          <DocumentProofTypeId>0</DocumentProofTypeId>
          <LicenseState>String</LicenseState>
          <RuleSetId>0</RuleSetId>
          <RuleTypeId>0</RuleTypeId>
        </RuleData>
        <RuleType>String</RuleType>
      </Rule>
    </RuleResult>
  </RuleResults>
  <RuleSetResults>
    <CustomerPolicyResult>
      <Aggregator>Unknown</Aggregator>
      <IsEligible>false</IsEligible>
      <Override>
        <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <EligibilityType>Unkown</EligibilityType>
        <Id>0</Id>
        <OverrideReasonId>0</OverrideReasonId>
        <PolicyId>0</PolicyId>
        <ShouldPass>false</ShouldPass>
        <UserId>00000000-0000-0000-0000-000000000000</UserId>
      </Override>
      <RuleResults>
        <RuleResult>
          <IsEligible>false</IsEligible>
          <Rule>
            <Description>String</Description>
            <Id>0</Id>
            <RuleData>
              <AlertTypeId>0</AlertTypeId>
              <AmountDueThreshold>0</AmountDueThreshold>
              <AmountPaidThreshold>0</AmountPaidThreshold>
              <BillTypeId>0</BillTypeId>
              <DocumentProofTypeId>0</DocumentProofTypeId>
              <LicenseState>String</LicenseState>
              <RuleSetId>0</RuleSetId>
              <RuleTypeId>0</RuleTypeId>
            </RuleData>
            <RuleType>String</RuleType>
          </Rule>
        </RuleResult>
      </RuleResults>
      <RuleSetResults>
        <CustomerPolicyResult>
          <Aggregator>Unknown</Aggregator>
          <IsEligible>false</IsEligible>
          <Override>
            <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
            <DateCreated>0001-01-01T00:00:00</DateCreated>
            <EligibilityType>Unkown</EligibilityType>
            <Id>0</Id>
            <OverrideReasonId>0</OverrideReasonId>
            <PolicyId>0</PolicyId>
            <ShouldPass>false</ShouldPass>
            <UserId>00000000-0000-0000-0000-000000000000</UserId>
          </Override>
          <RuleResults>
            <RuleResult>
              <IsEligible>false</IsEligible>
              <Rule>
                <Description>String</Description>
                <Id>0</Id>
                <RuleData>
                  <AlertTypeId>0</AlertTypeId>
                  <AmountDueThreshold>0</AmountDueThreshold>
                  <AmountPaidThreshold>0</AmountPaidThreshold>
                  <BillTypeId>0</BillTypeId>
                  <DocumentProofTypeId>0</DocumentProofTypeId>
                  <LicenseState>String</LicenseState>
                  <RuleSetId>0</RuleSetId>
                  <RuleTypeId>0</RuleTypeId>
                </RuleData>
                <RuleType>String</RuleType>
              </Rule>
            </RuleResult>
          </RuleResults>
          <RuleSetResults>
            <CustomerPolicyResult>
              <Aggregator>Unknown</Aggregator>
              <IsEligible>false</IsEligible>
              <Override>
                <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
                <DateCreated>0001-01-01T00:00:00</DateCreated>
                <EligibilityType>Unkown</EligibilityType>
                <Id>0</Id>
                <OverrideReasonId>0</OverrideReasonId>
                <PolicyId>0</PolicyId>
                <ShouldPass>false</ShouldPass>
                <UserId>00000000-0000-0000-0000-000000000000</UserId>
              </Override>
              <RuleResults>
                <RuleResult>
                  <IsEligible>false</IsEligible>
                  <Rule>
                    <Description>String</Description>
                    <Id>0</Id>
                    <RuleData>
                      <AlertTypeId>0</AlertTypeId>
                      <AmountDueThreshold>0</AmountDueThreshold>
                      <AmountPaidThreshold>0</AmountPaidThreshold>
                      <BillTypeId>0</BillTypeId>
                      <DocumentProofTypeId>0</DocumentProofTypeId>
                      <LicenseState>String</LicenseState>
                      <RuleSetId>0</RuleSetId>
                      <RuleTypeId>0</RuleTypeId>
                    </RuleData>
                    <RuleType>String</RuleType>
                  </Rule>
                </RuleResult>
              </RuleResults>
              <RuleSetResults i:nil="true" />
            </CustomerPolicyResult>
          </RuleSetResults>
        </CustomerPolicyResult>
      </RuleSetResults>
    </CustomerPolicyResult>
  </RuleSetResults>
</CustomerPolicyResult>