Get Quote Endpoints: GetQuotePdfWebService

API endpoints for retrieving quotes, inclusions, and insurance

GetQuotePdfWebService

This API allows you to run the getQuote) legacy web service via API.

This API returns your quote PDF.

To return fields use getQuoteFieldsWebService.

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Web%20Services/getQuotePdfWebService

Warning: If new development is being undertaken, use Render Quote PDF instead of this one. This API is marked for deprecation.

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.

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.test.catch-e.com/web-services/qt/quotes/getQuote/pdf?quote_id=100000

Query

Key	Format	Notes	Mandatory
quote_id	string	Enter Quote ID	Yes

Response

Validation Messages	Comments
200 OK
Quote PDF document.	The request was a successful request.
401 - Unauthorized

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

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

GetQuoteStatuses

Returns the Quotes / Contract "Quote Status" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quotes/getQuoteStatuses

Permissions

This method requires the permission QuoteStatuses:Get.

This permission is not available in Roles / Apis by default, but it can be enabled for you by Catch-e.
If enabled, you can then turn on this permission for your 'web services' role. Visit the process page Edit API permissions for the steps to do this.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

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/qt/quote-statuses

Parameters (Query Params)

Key	Format	Notes	Mandatory
description	string	Get a Quote Status description. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
active_flag	string	Get only Quote Statuses where the = 'yes'. Available values: yes, no.	No
includeinactiveflag	string	Set to yes if inactive Quote Sub Statuses are required in the list. Available values: yes, no. Default: no.	No
page	number	Optional page number. Default 1 page.	No
page_size	number	Optional page size. Default 25 records per page.	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.

GetQuoteSubStatuses

Returns the Quotes / Contract "Quote Status" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quotes/getQuoteSubStatuses

Permissions

This method requires the permission QuotesSubStatuses:Get.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

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/qt/quote-sub-statuses

Parameters (Query Params)

Key	Format	Notes	Mandatory
sub_status	string	Get a Quote Sub Status description. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
parentstatusdescription	string	Get only Quote Sub Statuses linked to a Quote Status. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
includeinactiveflag	string	Set to yes if inactive Quote Sub Statuses are required in the list. Available values: yes, no. Default: no.	No
page	number	Optional page number. Default 1 page.	No
page_size	number	Optional page size. Default 25 records per page.	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.

GetRoadsideAssistancePlans

Supporting API for patchQuote. Returns a list of active Roadside Assistance Plan details as seen in the Roadside Assistance (RSA) profile.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Roadside%20Assistance

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 RoadsideAssistancePlans:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

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/qt/roadside-assistance-plans

Parameters (Query Params)

Key	Format	Notes	Mandatory
roadsideassistanceplan_code	string	Get roadsideassistanceplan_id for a specific Roadside Assistance Plan.	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

GetTyreRimInsurancePlans

Supporting API for patchQuote. Returns a list of Tyre Rim Insurance Plan details as seen in the Tyre and Rim Insurance profile.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Tyre%20and%20Rim%20Insurance/getTyreRimInsurancePlans

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 TyreRimInsurancePlans:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

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/qt/tyre-rim-insurance-plans

Parameters (Query Params)

Key	Format	Notes	Mandatory
tyreriminsuranceplancode	string	Get roadsideassistanceplan_id for a specific Roadside Assistance Plan. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
name	string	Get roadsideassistanceplan_id using the plan name. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
state	string	Available values : NSW, ACT, NT, WA, SA, VIC, TAS, QLD, NZ.	No
status_flag	string	Available values : active, inactive. Default value: active	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	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.

GetTyres

Supporting API for patchQuote. Returns a list of Tyre details as seen in the Tyres (T) profile.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Tyres/getTyres(https://https://api.catch-e.com/docs/#/Quote%20%2F%20Tyres/getTyres)

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 Tyres: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.test.catch-e.com/qt/tyres

Parameters (Query Params)

Key	Format	Notes	Mandatory
tyre_code	string	Get tyre_id for a specific Tyre Code. This field supports the wildcard % operator.	No
make_id	string	Get a list of tyre_id/s for a specific Make ID.	No
manufacturertyrecode	string	Get a list of tyre_id/s for a specific Manufacturer Tyre Code. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
name	string	Get a list of tyre_id/s for a Tyre name. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
specification	string	Get a list of tyre_id/s based on Tyre Specification. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
rating	string	Get a list of tyre_id/s for a given Tyre Rating. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
type	string	Get a list of tyre_id/s for a Tyre type. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	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.

GetWalkawayPlans

Supporting API for patchQuote. Returns a list of Walkaway Plan details as seen in the Walkaway profile.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Walkaway/getWalkawayPlans

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 WalkawayPlans:Get.

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

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/qt/walkaway-plans

Parameters (Query Params)

Key	Format	Notes	Mandatory
walkawayplancode	string	Get walkawayplanid for a specific Walkaway Plan. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
name	string	Get walkawayplanid using the plan name. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
state	string	Available values : NSW, ACT, NT, WA, SA, VIC, TAS, QLD, NZ.	No
status_flag	string	Available values : active, inactive. Default value: active	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	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.