Skip to main content
Get Quote Endpoints

getQuoteFieldsWebService

getQuoteFieldsWebService

Overview

This method returns the quote template placeholders for a quote, with their values. It can return every placeholder or only the placeholders you request.

Use this API to aid quote template development. If you are using the recommended 'quote' library, the getQuote spreadsheet lists the placeholders available. See Quote Template Development for the placeholder libraries, including the insurance placeholders.

To generate a quote PDF, use the Render Quote PDF API.

This method requires the WebServices permission to be associated with your role.

Enable

Go to Setup / Reference Data > gb_controls and find the api_web_services_wrapper_login control.

Populate this control with a 'web_services' user login and password. This user is 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

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

URL Examples

https://api.demo.catch-e.com/web-services/qt/quotes/getQuote/fields?quote_id=100000 https://api.{environment}.catch-e.com/web-services/qt/quotes/getQuote/fields?quote_id=100000&fields=quote_id,after_tax_effect_per_pay_cycle 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

The Quote ID.

Yes

fields

string

As many placeholder names as required, comma-separated. The prefix return_ required by the legacy getQuote() web service is not needed. For example, to return the quote_id and after_tax_effect_per_pay_cycle, add fields=quote_id,after_tax_effect_per_pay_cycle. If no fields are requested, all fields are returned.

No

Response Details

Success

200 - OK

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

The request was successful.

Error Response Details

401 Unauthorized

Validation Message

Comments

401 - Unauthorized

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

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

403 Forbidden

Validation Message

Comments

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

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

418 Invalid Credentials

Validation Message

Comments

418 - Invalid Credentials

Web Services has not been enabled. Go to Setup / Reference Data > gb_controls, find the api_web_services_wrapper_login control and populate it with a 'web_services' user login and password.

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

422 Unprocessable Entity

Validation Message

Comments

422 - quote_id.noRecordFound

The Quote ID is invalid.

422 - web_service_error.emptyResponseFromUpstream

The call could not be processed. This can happen if an unknown field has been requested. See Quote Template Development for set-up and field details, and check field names in the getQuote spreadsheet if your quote library is 'quote'.

{ "quote_id": { "noRecordFound": "No record matching the input was found" } } 
{ "web_service_error": { "emptyResponseFromUpstream": "Empty response from upstream server" } } 

423 Locked

Validation Message

Comments

423 - Locked

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

{ "locked": true } 

424 Failed Dependency

Validation Message

Comments

424 - Failed Dependency

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

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