GetClient

Enables you to get all fields for a given Client including associated Client Bespoke fields, Quote Defaults and Contract Defaults.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Clients

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on Clients:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/clients/{client_id}

Response Details

Validation Message	Comments
201 Created	A successful response returns all fields in the client record, bespoke field values, inclusion/exclusion records, and associated Client Defaults and Client Packaging Defaults records
403 - Forbidden	You do not have permissions for this request
422 - Unprocessable Entity	The page limit is capped at 100 records. Update to keep the page size at or below 100 records
422 - Unprocessable Entity	The syntax of the fields key is not correct. Having spaces in the list of fields is one possible reason

GetClientCostCentres

Enables you to get a list of a client's cost centre records stored in the table.

Visit the Clients / Cost Centres page for full details.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Client%20%2F%20Client%20Cost%20Centres/getClientCostCentres

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on ClientCostCentres:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/client-cost-centres

Parameters - Query

Key	Format	Notes	Default Value	Mandatory
client_id	string	Pass the Client ID to retrieve that client's cost centre records		Yes
description	string	This field supports the wildcard % operator		No
include_inactive_flag	string	Records with an 'inactive' status are not returned by default. Set this key to 'yes' to return inactive records in the list. Note: 'deleted' records cannot be returned	no	No
fields	string	Define specific fields to return limited details. If no fields are specified, then all fields are returned. List the fields separated by a comma, with no spaces		No
page	number	Returns all pages by default. You can limit the results with this input value	1	No
page_size	number	25 results per page are returned by default. You can limit the results with this input value	25	No

Wildcard % Operator Notes

If you are using "Postman" app with the wildcard operator, the search string of either %ab% or %ba% will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation Message	Comments
200 OK	A successful response returns all fields in the table record
403 - Forbidden	You do not have permissions for this request
422 - Unprocessable Entity	The syntax of the fields key is not correct. Having spaces in the list of fields is one possible reason

GetClientDivisions

Enables you to get a list of "Divisions" values found on the Client / Divisions page.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Client%20Divisions/getClientDivisions

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on ClientDivisions:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/client-divisions

Parameters - Query

Key	Format	Notes	Default Value	Mandatory
client_id	string	Client ID		Yes
description	string	This field supports the wildcard % operator		No
fields	array	Define fields required. If no fields are specified, then all fields are returned		No
include_deleted_flag	string	yes or no	no	No
page	number	Returns all pages by default. You can limit the results with this input value	1	No
page_size	number	25 results per page are returned by default. You can limit the results with this input value	25	No

Wildcard % Operator Notes

If you are using "Postman" app with the wildcard operator, the search string of either %ab% or %ba% will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation Message	Comments
201 Created	A successful response returns all fields in the table
403 - Forbidden	You do not have permissions for this request
422 - Unprocessable Entity	The syntax of the fields key is not correct. Having spaces in the list of fields is one possible reason