GetQuoteEventActions

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

GET

URL

https://api.catch-e.com/qt/quote-event-codes/

Query Parameters

Key

Format

Notes

Mandatory

quote_event_code

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

name

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

description

string

Supports wildcard % operator. Example: %test%Event%description%

No

include_deleted_flag

string

Only 'active' Quote Event Codes returned by default. Set to 'yes' to include 'deleted' codes.

No

page

string

Limit results by page

No

page_size

string

Limit results by page size

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

Response - 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.

Response - 401 Unauthorized

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

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 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.

GetQuoteEvents

Returns details for all Quote Events based on input parameters.

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

GET

URL

https://api.catch-e.com/qt/quote-events/

Query Parameters

Key Format Notes Mandatory

client_group_id

string

Filter results by Client Group

No

client_id

string

Filter results by Client

No

driver_id

string

Filter results by Driver

No

quote_status_id

string

Filter results by Quote Status

No

quote_id

string

Filter results by Quote

No

parent_quote_id

string

Filter results by Parent Quote ID

No

opportunity_number

string

Filter results by Opportunity Number

No

quote_event_code_id

string

Filter results by Event Code

No

event_date

string

Filter results by Event Date

No

event_date_from

string

Filter results by Event Date (From)

No

event_date_to

string

Filter results by Event Date (To)

No

quote_event_action_id

string

Filter results by Event Action

No

due_date

string

Filter results by Due Date

No

completed_flag

string

Filter results by Completed Flag

No

user_id_edit

string

Filter results by Last Edit By

No

description

string

Filter results by Event Description. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

string

Limit results by page

No

page_size

string

Limit results by page size

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

Response - 200 OK

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/" } }, "_embedded": { "qt_quote_events": [ { "quote_event_id": "100096", "quote_id": "132580", "quote_event_code_id": "100001", "event_date": "2022-11-09", "description": "Re-Test#2: Event Code: Notes (API)", "event_amount": 1.02, "quote_event_action_id": "100001", "due_date": "2022-11-11", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-13 23:28:59", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/100096" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100001", "quote_event_code": "Notes", "name": "Notes", "description": "Quote Note", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100001", "name": "Request Docs" } } }, { "quote_event_id": "100097", "quote_id": "132580", "quote_event_code_id": "100000", "event_date": "2022-11-08", "description": "Re-Test#3: Event Code: Dealer Pricing (API)", "event_amount": 1.01, "quote_event_action_id": "100000", "due_date": "2022-11-10", "completed_flag": "no", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-13 23:28:59", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/100097" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100000", "quote_event_code": "Dealer", "name": "Dealer Pricing", "description": "Dealer Pricing Attached", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100000", "name": "Follow Up" } } } ] }, "total_items": 2 }

The request was successful.

Response - 401 Unauthorized

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

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 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.

Response - 422 Unprocessable Entity

{ "validation_messages": { "quote_event_id": { "noRecordFound": "No record matching the input was found" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Quote Event ID not found.

GetQuoteFieldsWebService

Returns quote template placeholders. Can return all placeholders or requested placeholders. Use this API to aid quote template development.

The getQuote spreadsheet contains a list of placeholders available if using the 'quote' library. To generate quote PDF, use the Render Quote PDF API.

Setup

Go to Setup / Reference Data and find the gbcontrols "apiwebserviceswrapper_login" control. Populate with a 'web_services' user login and password. This user will be used to run the API from within code.

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 WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.test.catch-e.com/web-services/qt/quotes/getQuote/fields?quote_id=100000&fields=quote_id,after_tax_effect_per_pay_cycle

Query Parameters

Key

Format

Notes

Mandatory

quote_id

string

Quote ID

Yes

fields

string

Field names comma-separated (no spaces). Prefix 'return' not required. Example: fields=quote_id,after_tax_effect_per_pay_cycle. If no fields requested, all fields returned.

No

Response - 200 OK

{ "after_tax_effect_per_pay_cycle": 1456.51, "quote_id": 132606 }

The request was successful.

Response - 401 Unauthorized

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

You have not authenticated or your token_timeout has passed. Authenticate again.

Response - 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.

Response - 418 Invalid Credentials

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Invalid Credentials", "status": 418, "detail": "Web services API wrapper credentials have not been configured" }

Web Services setup required. Go to Setup / Reference Data and find apiwebserviceswrapper_login control. Populate with 'web_services' user login and password.

Response - 422 Unprocessable Entity

Invalid Quote ID:

{ "quote_id": { "noRecordFound": "No record matching the input was found" } }

Empty response from upstream:

{ "web_service_error": { "emptyResponseFromUpstream": "Empty response from upstream server" } }

The call could not be processed. This can happen if unknown field passed. Visit Quote Template Placeholders page and check field names in getQuote spreadsheet if using 'quote' library.

Response - 423 Locked

{ "locked": true }

Quote is being edited. Try again once quote no longer in use.

Response - 424 Failed Dependency

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 424, "detail": "Upstream service temporarily unavailable. Please retry." }

API cannot run at this time. Service resource limits exceeded or system in maintenance mode.