GetChildQuote

Retrieve all child, grand-child, great-grand-child, and great-great-grand-child Quotes for a given Quote ID.

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 Quotes:GetChildQuotes.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL

https://api.catch-e.com/qt/quotes/100000/child-quotes https://api.catch-e.com/qt/quotes/:quote_id/child-quotes

Path Variables

Key	Format	Notes	Mandatory
quote_id	string	Parent Quote	Required

Query Parameters

Key	Format	Notes	Mandatory
depth	integer	Depth of child, grand-child, great-grand-child quotes to retrieve. Default: 100. Maximum: 100.	Optional

Response - 200 OK

{ "quote_id": 132616, "child_quotes": [ { "quote_id": 132617, "child_quotes": [ { "quote_id": 132618, "child_quotes": [ { "quote_id": 132619, "child_quotes": [ { "quote_id": 132620, "child_quotes": [ { "quote_id": 132621, "child_quotes": [ { "quote_id": 132622, "child_quotes": [ { "quote_id": 132623 } ] } ] } ] } ] } ] } ] }, { "quote_id": 132671 } ] }

The request was successful. In this example, a depth of 7 was used. The parent quote (132616) has a child quote (132617), grand-child quote (132618), great-grand-child quote (132619), great-great-grand-child quote (132620), great-great-great-grand-child quote (132621), great-great-great-great-grand-child quote (132622), and great-great-great-great-great-grand-child quote (132623). Also another child quote (132671).

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. You need to 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

Invalid Quote ID:

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

Circular reference:

{ "parent_quote_id": { "invalidData": "Circular reference found 132616 -> 132617 -> 132616" } }

Circular reference detected. Child of a Parent is also the Parent of the Child.

Invalid depth:

{ "depth": { "notBetween": "The input is not between '1' and '100', inclusively" } }

Maximum depth is 100.

GetInclusion

Supporting API for patchQuote. Returns details of a specific Inclusion as seen in the Inclusion profile.

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

Permissions

Go to Roles / APIs and check on Inclusions: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/inclusion/{inclusion_id}

Parameters

Key	Format	Notes	Mandatory
inclusion_id	string	Get details for specific Lease Inclusion	No

GetInclusionPlan

Supporting API for patchQuote. Returns details of a specific Inclusion Plan as seen in the Inclusion profile.

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

Permissions

Go to Roles / APIs and check on InclusionPlans: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/inclusion-plans/{inclusion_plan_id}

Parameters

Key	Format	Notes	Mandatory
inclusion_plan_id	string	Get details for specific Lease Inclusion Plan	No

GetInclusionPlans

Supporting API for patchQuote. Returns list of Inclusion Plans as seen in the Inclusion profile.

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

Permissions

Go to Roles / APIs and check on InclusionPlans: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/inclusion-plans

Query Parameters

Key	Format	Notes	Mandatory
inclusion_code	string	Limit results to Lease Inclusion Plans for specific Lease Inclusion Code	No
inclusion_plan_code	string	Limit results to specific Lease Inclusion Plan Code	No
include_inactive_flag	string	Only active Inclusion Plans shown by default. Set to 'yes' to include inactive plans.	No
page	string	Skip to specific page of results	No
page_size	string	Number of records to return per page	No

GetInclusions

Supporting API for patchQuote. Returns list of Inclusions as seen in the Inclusion profile.

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

Permissions

Go to Roles / APIs and check on Inclusions: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/inclusions

Query Parameters

Key	Format	Notes	Mandatory
inclusion_code	string	Get list of Lease Inclusions	No
edit_flag	string	Limit results based on edit_flag	No
provider	string	Limit results based on provider (Supplier)	No
page	string	Skip to specific page of results	No
page_size	string	Number of records to return per page	No

GetInsuranceLoadingType

Supporting API for patchQuote. Returns details of a specific Insurance Loading Type as seen on Comprehensive Insurance profile.

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

Permissions

Go to Roles / APIs and check on InsuranceLoadingTypes: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/insurance-loading-types/{insurance_loading_type_id}

Path Variable

Key	Format	Notes	Mandatory
insurance_loading_type_id	string	Returns details of specific Insurance Loading Type	No

GetInsuranceLoadingTypes

Supporting API for patchQuote. Returns list of Insurance Loading Types as seen on Comprehensive Insurance profile.

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

Permissions

Go to Roles / APIs and check on InsuranceLoadingTypes: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/insurance-loading-types

Query Parameters

Key	Format	Notes	Mandatory
loading_type	string	Get list of Insurance Loading Types for specific Loading Type. Choose: 'pastclaims', 'licence', 'driverrestrictions'	No
page	string	Skip to specific page of results	No
page_size	string	Number of records to return per page	No

GetInsuranceType

Supporting API for patchQuote. Returns details of a specific Insurance Type as seen on Comprehensive Insurance profile.

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

Permissions

Go to Roles / APIs and check on InsurerLocations: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/insurer-locations/:insurance_type_id

Path Variable

Key	Format	Notes	Mandatory
insurance_type_id	string	Returns details of specific Insurance Type	No

GetInsuranceTypes

Supporting API for patchQuote. Returns list of Insurance Types as seen on Comprehensive Insurance profile.

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

Permissions

Go to Roles / APIs and check on InsurerLocations: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/insurer-locations

Query Parameters

Key	Format	Notes	Mandatory
insurance_type_code	string	Get list of Insurance Types for specific Type code (e.g. STD, HP)	No
type_category	string	Get list of Insurance Types for specific type category	No
high_performance_flag	string	Get list of High Performance flagged Insurance Types	No
page	string	Skip to specific page of results	No
page_size	string	Number of records to return per page	No

GetInsurerLocation

Supporting API for patchQuote. Returns details of a specific Insurance Location as seen on Comprehensive Insurance profile.

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

Permissions

Go to Roles / APIs and check on InsurerLocations: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/insurer-locations/:insurer_location_id

Query Parameter

Key	Format	Notes	Mandatory
insurer_location_id	string	Returns details of specific Insurance Location	No