Skip to main content
Get Quote Endpoints

GetQuoteEventCodes

GetQuoteEventCodes

Overview

This API returns Quote Event Code details.

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 QuoteEvents:Get.

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/quote-event-codes/ 

Input Parameters

Key

Format

Notes

Mandatory

quote_event_code

string

This field supports the wildcard % operator (See Wildcard % operator notes below).

No

name

string

This field supports the wildcard % operator (See Wildcard % operator notes below).

No

description

string

This field supports the wildcard % operator (See Wildcard % operator notes below).

e.g. %test%Event%description%

No

include_deleted_flag

string

Only 'active' Quote Event Codes are returned by default, to include Quote Events Codes with a 'deleted' status set this parameter to 'yes'.

No

page

string

Limit results by page

No

page_size

string

Limit results by page size

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

200 OK

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-event-codes/?page_size=1&page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/quote-event-codes/?page_size=1" }, "last": { "href": "https://api.test.catch-e.com/qt/quote-event-codes/?page_size=1&page=5" }, "next": { "href": "https://api.test.catch-e.com/qt/quote-event-codes/?page_size=1&page=2" } }, "_embedded": { "qt_quote_event_codes": [ { "quote_event_code_id": "100000", "quote_event_code": "Dealer", "name": "Dealer Pricing", "description": "Dealer Pricing Attached", "template_id": "0", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-event-codes/100000" } } } ] }, "page_count": 5, "page_size": 1, "total_items": 5, "page": 1 }

The request was successful.

401 Unauthorized

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

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

403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.