Get Quote Endpoints: GetQuoteEventActions

API endpoints for retrieving quotes, inclusions, and insurance

GetQuoteEventActions

This API returns Quote Event Action 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-actions/

Input Parameters

Key	Format	Notes	Mandatory
name	string	This field supports the 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 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 Messages	Comments
200 OK

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-event-actions/?page_size=1&page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/quote-event-actions/?page_size=1" }, "last": { "href": "https://api.test.catch-e.com/qt/quote-event-actions/?page_size=1&page=3" }, "next": { "href": "https://api.test.catch-e.com/qt/quote-event-actions/?page_size=1&page=2" } }, "_embedded": { "qt_quote_event_actions": [ { "quote_event_action_id": "100000", "name": "Follow Up", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-event-actions/100000" } } } ] }, "page_count": 3, "page_size": 1, "total_items": 3, "page": 1}

{ "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 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. |

GetQuoteEventCodes

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
quoteeventcode	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
includedeletedflag	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

Validation Messages	Comments
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}

{ "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 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. |

GetQuoteEvents

This API 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

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

URL Examples

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

Input Parameters

Key	Format	Notes	Mandatory
clientgroupid	string	Filter results by Client Group	No
client_id	string	Filter results by Client	No
driver_id	string	Filter results by Driver	No
quotestatusid	string	Filter results by Quote Status	No
quote_id	string	Filter results by Quote	No
parentquoteid	string	Filter results by Parent Quote ID	No
opportunity_number	string	Filter results by Opportunity Number	No
quoteeventcode_id	string	Filter results by Event Code	No
event_date	string	Filter results by Event Date	No
eventdatefrom	string	Filter results by Event Date (From)	No
eventdateto	string	Filter results by Event Date (To)	No
quoteeventaction_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
useridedit	string	Filter results by Last Edit By	No
description	string	Filter results by Event Description. This field supports the 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 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 Messages	Comments
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}

{ "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 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. |
| 422 - Unprocessable Content | | |

{ "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

This API returns quote template placeholders.

It can returns all placeholders or requested placeholders.
The getQuote spreadsheet contains a list of the placeholders that are available if you are using the recommended 'quote' library.

To generate your quote PDF use the Render Quote PDF API.

Use this API to aid quote template development.

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control with a 'web_services' user login and password.
This user will be used to run the API from within code.

Permission

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

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

URL Examples

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

Key	Format	Notes	Mandatory
quote_id	string	Quote ID	Yes

| fields | string | As many of the Field Name(s) as required comma separated. The prefix 'return' (required by the getQuote) legacy web service) is not required when using this API. For example, to return the quoteid and aftertaxeffectperpaycycle, add fields=quoteid,aftertaxeffectperpay_cycle
If no fields are requested then all fields are returned. | No |

Response Details

Validation Messages	Comments
200 OK

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

{ "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 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. |
| 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"}

| You need to enable Web Services Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapperlogin" control. Populate this control with a 'webservices' user login and password. This user will be used to run the API from within code. |
| 422 - Unprocessable Entity | | |

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

| Invalid Quote ID | |

 "web_servic_error": { "emptyResponseFromUpstream": "Empty response from upstream server"

| The call could not be processed. This can happen if an unknown field has been passed. Visit the Quote Template Placeholders page for more set-up and field details and open the getQuote spreadsheet to check field names if your quote library is 'quote'. |
| 423 - Locked | | |

 "locked":

| The quote is being edited. Try again once the quote is no longer in use. |
| 424 - Failed Dependency | | |

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

| The API cannot run at this time. This can happen for a various reasons, for example: service resource limits have been exceeded the system is in maintenance mode |