BootView WebApi

<back to all web services

OverrideEligibilityPolicy

The following routes are available for this service:
PUT/releaseeligibility/{id}/Permanently overrides the given release eligibility policy result with a PASS or FAIL result. A policy can only have ONE override result/reason at a time.
OverrideEligibilityPolicy Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe Boot Collection Attempt Id for which to override the release eligibility result.
ShouldPassbodyboolYesWhether the result should always pass (true | false).
ReasonIdbodyintYesThe Id of the reason given for overriding the eligibility result.
TypebodyEligibilityTypeYesWhich policy to override. (SelfRelease | AssistedRelease)
EligibilityOverrideReturn Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ShouldPassformboolNo

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

<OverrideEligibilityPolicy 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>
  <ReasonId>0</ReasonId>
  <ShouldPass>false</ShouldPass>
  <Type>Unkown</Type>
</OverrideEligibilityPolicy>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EligibilityOverrideReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Id>0</Id>
  <ShouldPass>false</ShouldPass>
</EligibilityOverrideReturn>