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

HTTP + X-MSGPACK

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

POST /x-msgpack/reply/OverrideEligibilityPolicy HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"id":"00000000000000000000000000000000","shouldPass":false,"reasonId":0,"type":"Unkown"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"id":0,"shouldPass":false}