getCauseCodes

Overview

Get a list of cause codes.

This method requires the CauseCodes:Get permission to be associated with your role.

It performs the same function as the corresponding action in the Approvals screen.

Permissions

The permission for this API is stored in [gb_api_permissions]permission as 'CauseCodes:Get'.

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

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/fm/cause-codes

https://api.{{environment}}.catch-e.com/fm/cause-codes

https://api.test.catch-e.com/fm/cause-codes

Input Fields (Query)

Key	Format	Notes	Mandatory	Default
cause_code	string	Optional Cause Code	No
page	integer	Optional page number	No	1
page_size	integer	Optional page size	No	25

Response Details

Success

200 - Success

{  "_links": {  "self": {  "href": "https://api.catch-e.loc/fm/cause-codes"  }  },  "_embedded": {  "fm_cause_codes": [  {  "cause_code_id": "string",  "cause_code": "string",  "description": "string"  }  ]  },  "page_count": 1,  "page_size": 25,  "total_items": 1,  "page": 1 }

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
409 - Conflict

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

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" }