BootView WebApi

<back to all web services

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:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe unique boot collection attempt Id.
TypequeryEligibilityTypeNoSelfRelease | AssistedRelease. Defaults to SelfRelease if not provided.
CustomerPolicyResult Parameters:
NameParameterData TypeRequiredDescription
AggregatorformEligibilityRuleSetAggregatorNo
IsEligibleformboolNo
OverrideformPolicyOverrideNo
RuleResultsformList<RuleResult>No
RuleSetResultsformList<CustomerPolicyResult>No
PolicyOverride Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CollectionAttemptIdformGuidNo
DateCreatedformDateTimeNo
EligibilityTypeformEligibilityTypeNo
OverrideReasonIdformintNo
PolicyIdformintNo
ShouldPassformboolNo
UserIdformGuidNo
RuleResult Parameters:
NameParameterData TypeRequiredDescription
RuleformRuleNo
IsEligibleformboolNo
Rule Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
RuleTypeformstringNo
RuleDataformRuleDataNo
RuleData Parameters:
NameParameterData TypeRequiredDescription
AlertTypeIdformint?No
AmountDueThresholdformdecimal?No
AmountPaidThresholdformdecimal?No
BillTypeIdformint?No
DocumentProofTypeIdformint?No
RuleTypeIdformintNo
RuleSetIdformintNo
LicenseStateformstringNo

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/GetReleaseEligibility HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetReleaseEligibility xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Type>Unkown</Type>
</GetReleaseEligibility>
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>