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
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
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.
Was this helpful?
More in Get Quote Endpoints
GetChildQuoteGetInsurerLocationsGetDealerOrdergetQuoteFieldsWebServiceStill need help? Ask the team