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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/GetReleaseEligibility HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"id":"00000000000000000000000000000000","type":"Unkown"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"aggregator":"Unknown","isEligible":false,"override":{"id":0,"collectionAttemptId":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","eligibilityType":"Unkown","overrideReasonId":0,"policyId":0,"shouldPass":false,"userId":"00000000000000000000000000000000"},"ruleResults":[{"rule":{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}},"isEligible":false}],"ruleSetResults":[{"aggregator":"Unknown","isEligible":false,"override":{"id":0,"collectionAttemptId":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","eligibilityType":"Unkown","overrideReasonId":0,"policyId":0,"shouldPass":false,"userId":"00000000000000000000000000000000"},"ruleResults":[{"rule":{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}},"isEligible":false}],"ruleSetResults":[{"aggregator":"Unknown","isEligible":false,"override":{"id":0,"collectionAttemptId":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","eligibilityType":"Unkown","overrideReasonId":0,"policyId":0,"shouldPass":false,"userId":"00000000000000000000000000000000"},"ruleResults":[{"rule":{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}},"isEligible":false}],"ruleSetResults":[{"aggregator":"Unknown","isEligible":false,"override":{"id":0,"collectionAttemptId":"00000000000000000000000000000000","dateCreated":"\/Date(-62135596800000-0000)\/","eligibilityType":"Unkown","overrideReasonId":0,"policyId":0,"shouldPass":false,"userId":"00000000000000000000000000000000"},"ruleResults":[{"rule":{"id":0,"description":"String","ruleType":"String","ruleData":{"alertTypeId":0,"amountDueThreshold":0,"amountPaidThreshold":0,"billTypeId":0,"documentProofTypeId":0,"ruleTypeId":0,"ruleSetId":0,"licenseState":"String"}},"isEligible":false}],"ruleSetResults":null}]}]}]}