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. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | Guid | Yes | The Boot Collection Attempt Id for which to override the release eligibility result. |
ShouldPass | body | bool | Yes | Whether the result should always pass (true | false). |
ReasonId | body | int | Yes | The Id of the reason given for overriding the eligibility result. |
Type | body | EligibilityType | Yes | Which policy to override. (SelfRelease | AssistedRelease) |
Unkown |
Notice |
Boot |
Tow |
SelfRelease |
AssistedRelease |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
ShouldPass | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /releaseeligibility/{id}/ HTTP/1.1
Host: api.paylock.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"00000000000000000000000000000000","shouldPass":false,"reasonId":0,"type":"Unkown"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"id":0,"shouldPass":false}