GetQuotePdfWebService

GetQuotePdfWebService

Returns your quote PDF. To return fields, use getQuoteFieldsWebService.

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

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

Setup

Go to Setup / Reference Data and find the gbcontrols "apiwebserviceswrapper_login" control. Populate 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

GET

URL

https://api.catch-e.com/web-services/qt/quotes/getQuote/pdf?quote_id=100000

Query Parameters

Key

Format

Notes

Mandatory

quote_id

string

Enter Quote ID

Yes

Response - 200 OK

Quote PDF document.

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

Web Services setup required. Go to Setup / Reference Data and find apiwebserviceswrapper_login control. Populate with 'web_services' user login and password.

Response - 422 Unprocessable Entity

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

Invalid Quote ID.

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

API cannot run at this time. Service resource limits exceeded or system in maintenance mode.

GetQuoteStatuses

Returns the Quotes / Contract "Quote Status" list. Use this selection in patchQuote.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/getQuoteStatuses

Permissions

This method requires permission QuoteStatuses:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

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

Query Parameters

Key

Format

Notes

Mandatory

description

string

Get Quote Status description. Supports wildcard % operator (See Wildcard % operator notes below)

No

active_flag

string

Get only Quote Statuses where active_flag = 'yes'. Values: yes, no

No

include_inactive_flag

string

Set to 'yes' for inactive Quote Sub Statuses in list. Values: yes, no. Default: no

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

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.

GetQuoteSubStatuses

Returns the Quotes / Contract "Quote Sub Status" list. Use this selection in patchQuote.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/getQuoteSubStatuses

Permissions

This method requires permission QuoteSubStatuses:Get. Not available in Roles / APIs by default, but can be enabled by Catch-e. Once enabled, turn on for your 'web_services' role via Edit API permissions process.

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

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/quote-sub-statuses

Query Parameters

Key

Format

Notes

Mandatory

sub_status

string

Get Quote Sub Status description. Supports wildcard % operator (See Wildcard % operator notes below)

No

parent_status_description

string

Get only Quote Sub Statuses linked to Quote Status. Supports wildcard % operator (See Wildcard % operator notes below)

No

include_inactive_flag

string

Set to 'yes' for inactive Quote Sub Statuses in list. Values: yes, no. Default: no

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

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.

GetRoadsideAssistancePlans

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

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

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/roadside-assistance-plans

Query Parameters

Key

Format

Notes

Mandatory

roadside_assistance_plan_code

string

Get roadside_assistance_plan_id for specific Roadside Assistance Plan

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

GetTyreRimInsurancePlans

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

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

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/tyre-rim-insurance-plans

Query Parameters

Key

Format

Notes

Mandatory

tyre_rim_insurance_plan_code

string

Get tyre_rim_insurance_plan_id for specific plan. Supports wildcard % operator (See Wildcard % operator notes below)

No

name

string

Get tyre_rim_insurance_plan_id using plan name. Supports 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: active

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

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.

GetTyres

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

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

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave off for better security.

Go to Roles / APIs and check on Tyres:Get.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/tyres

Query Parameters

Key

Format

Notes

Mandatory

tyre_code

string

Get tyre_id for specific Tyre Code. Supports wildcard % operator

No

make_id

string

Get tyre_id list for specific Make ID

No

manufacturer_tyre_code

string

Get tyre_id list for specific Manufacturer Tyre Code. Supports wildcard % operator (See Wildcard % operator notes below)

No

name

string

Get tyre_id list for Tyre name. Supports wildcard % operator (See Wildcard % operator notes below)

No

specification

string

Get tyre_id list based on Tyre Specification. Supports wildcard % operator (See Wildcard % operator notes below)

No

rating

string

Get tyre_id list for given Tyre Rating. Supports wildcard % operator (See Wildcard % operator notes below)

No

type

string

Get tyre_id list for Tyre type. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

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.

GetWalkawayPlans

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

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

Permissions

To run this API, the nominated 'web-services' role needs permission.

If not actively using, leave 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.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/walkaway-plans

Query Parameters

Key

Format

Notes

Mandatory

walkaway_plan_code

string

Get walkaway_plan_id for specific Walkaway Plan. Supports wildcard % operator (See Wildcard % operator notes below)

No

name

string

Get walkaway_plan_id using plan name. Supports 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: active

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25

No

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.