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
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
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" } 403 Forbidden
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" } 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" } 422 Unprocessable Entity
{ "quote_id": { "noRecordFound": "No record matching the input was found" } } { "web_service_error": { "emptyResponseFromUpstream": "Empty response from upstream server" } } 423 Locked
{ "locked": true } 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." } Was this helpful?
More in Get Quote Endpoints
GetChildQuoteGetInsurerLocationsGetQuickQuoteWebServiceGetQuoteEventActionsStill need help? Ask the team