getContractPayoutStatuses

Overview

This method returns a list of configured contract payout statuses.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractPayoutStatuses: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/contract/payout/statuses 
https://api.{{environment}}.catch-e.com/fm/contract/payout/statuses https://api.test.catch-e.com/fm/contract/payout/statuses

Query Parameters

Key	Format	Notes	Mandatory
restricted_flag	boolean	Set to `true` to restrict the list to statuses available to you for update and transition operations. Default `false`.	No
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Each record in _embedded.items contains:

Field	Format	Notes
contract_payout_status_id	string	Contract Payout Status Id.
description	string	Status description.
status_flag	string	Values: `active`, `inactive`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/payout/statuses?page=1" } }, "_embedded": { "items": [ { "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/payout/statuses/1" } }, "contract_payout_status_id": "1", "description": "Pending", "status_flag": "active" } ] }, "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	No contract payout statuses were 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	The Accept header of the request does not match a response format this API supports.

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

Validation Message	Comments
409 - Conflict	The request conflicts with the current state of the data.

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

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

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

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

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