unpostClaim

unpostClaim

Overview

Unpost a claim.

Unpost an claim.

An fm_approvals table lock is obtained during the execution of this API.

This method requires the Contract:UnpostClaim permission to be associated with your role.

It performs the same function as the corresponding action in the Contract / Claims screen.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Contract:UnpostClaim'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contract/claims/{approval_id}/unpost

https://api.{{environment}}.catch-e.com/fm/contract/claims/{approval_id}/unpost

https://api.test.catch-e.com/fm/contract/claims/{approval_id}/unpost

Input Fields (Path)

Key

Format

Notes

Mandatory

approval_id

string

Yes

Input Fields (Header)

Key

Format

Notes

Mandatory

Delegated-Locking-Session-Id

string

(Optional) Locking responsibility will be delegated to the specified Session Id. This header enables the client to instruct the API to merely verify the presence of locks with the specified session id, but not attempt to obtain them itself. It requires the DelegatedLocking permission to be associated with your role.

No

Audit-User-Id

string

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

No

Time-Zone

string

Claims will be processed in the specified timezone. The timezone value can be given in several formats, none of which are case sensitive: - As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'. - As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

No

Response Details

Success

204 - Success

Error Response Details

Validation Message

Comments

401 Unauthorized

1. You have not authenticated before running this API or
2. The token_timeout of the current session has passed. You need to authenticate again.

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Unauthorized",  "status": 401,  "detail": "Unauthorized" }

Validation Message

Comments

403 Forbidden

- You do not have permissions for this request.
- Go to System Roles and enter 'web_services'
- Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Forbidden",  "status": 403,  "detail": "Forbidden" }

Validation Message

Comments

404 - Not Found

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Not Found",  "status": 404,  "detail": "Not Found" }

Validation Message

Comments

406 - Not Acceptable

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Not Acceptable",  "status": 406,  "detail": "Not Acceptable" }

Validation Message

Comments

422 - Unprocessible Entity

- Data being passed in the described field is invalid, the format is invalid or it is missing

{  "warning_messages": {  "fieldName": {  "warningExceptionCode": "A textual description of the warning exception"  }  },  "validation_messages": {  "fieldName": {  "validationExceptionCode": "A textual description of the validation exception"  }  },  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Unprocessable Entity",  "status": 422,  "detail": "Failed Validation" }

Validation Message

Comments

500 - Internal Error

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "string",  "status": 599,  "detail": "string" }

Validation Message

Comments

default - Unexpected Error

{  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "string",  "status": 599,  "detail": "string" }