GetClientGroups

Enables you to get the details of client group records.

See also Fleet / Administration / Client Groups / Contact.

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

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 ClientGroups: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-groups

Body (JSON)

JSON	Field Format	Notes	Mandatory
client_group_id	number	Pass a unique Client Group ID	No
client_group_code	string	Pass the Client Group Code. This field supports the wildcard % operator	No
name	string	Pass the Client Group name. This field supports the wildcard % operator	No
client_group_id_external	string	Pass the Client Group External ID. This field supports the wildcard % operator	No
page	number	Returns all pages by default. You can limit the results with this input value	No
page_size	number	25 results per page are returned by default. You can limit the results with this input value	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 client group record
403 - Forbidden	You do not have permissions for this request

GetClientIndustries

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

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 ClientIndustries: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-industries

Parameters - Query

Key	Format	Notes	Default Value	Mandatory
client_industry_code	string	Optional Client Industry Code. This field supports the wildcard % operator		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 client industries 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

GetCompetitorMargins

Returns the Quotes / Contract "Lost By" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Competitor%20Margins/getCompetitorMargins

Permissions

This method requires the permission CompetitorMargins:Get.

This permission is not available in Roles / APIs by default, but it can be enabled for you by Catch-e. If enabled, you can then turn on this permission for your 'web services' role. Visit the Edit API permissions page for the steps to do this.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/competitor-margins

Parameters (Query Params)

Key	Format	Notes	Mandatory
description	string	Get a competitor margin description. This field supports the wildcard % operator	No
include_inactive_flag	string	yes or no. Set to yes if inactive Competitors required in the list	No
page	number	Optional page number. Default 1 page	No
page_size	number	Optional page size. Default 25 records per page	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.

GetCompetitors

Returns the Quotes / Contract "Competitor" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Competitors

Permissions

This method requires the permission Competitors:Get.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/qt/competitors

Parameters (Query Params)

Key	Format	Notes	Mandatory
name	string	Get a competitor description. This field supports the wildcard % operator	No
include_inactive_flag	string	Set to yes if inactive Competitors required in the list	No
page	number	Optional page number. Default 1 page	No
page_size	number	Optional page size. Default 25 records per page	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.