Get Quote Endpoints: GetChildQuote

API endpoints for retrieving quotes, inclusions, and insurance

GetChildQuote

This API allows you to retrieve all child, grand-child, great-grand-child, 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 Examples

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

Path Variables

KeyFormatNotesMandatory
quote_idstringParent Quote.Required

Query (Path) Parameters

KeyFormatNotesMandatory
depthintegerThis represents the depth of how many child, grand-child, great-grand-child or great-great-grand-child Quotes you want to retrieve. The default is 100 which is also the maximum depth.Optional

Response Details

Validation MessagesComments
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 } ] } ] } ] } ] } ] } ] } ]}

| The request was a successful request. In this example, a depth of 7 was used. The Parent Quote ID 132616 has a child Quote (132617) and a grand-child Quote (132618) and a great-grand-child Quote (132619) and a great-great-grand-child Quote (132620) and a great-great-great-grand-child Quote (132621) and a great-great-great-great-grand-child Quote (132622) and a great-great-great-great-great-grand-child Quote (132623). |
| 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. |
| 422 - Unprocessable Entity | | |

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

| Invalid Quote ID | |

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

| Circular reference. For example, the Child of a Parent is also the Parent of the Child. | |

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

| The maximum depth is 100. |

GetChildQuotes

This API allows you to retrieve all child, grand-child, great-grand-child, 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 Examples

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

Query Parameters

KeyFormatNotesMandatory
depthintegerThis represents the depth of how many child, grand-child, great-grand-child or great-great-grand-child Quotes you want to retrieve. The default is 100 which is also the maximum depth.Optional

Path Variables

KeyFormatNotesMandatory
quote_idstringParent Quote.Required

Responses

Validation MessagesComments
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 a successful request. In this example, a depth of 7 was used. The parent quote (132616) has a child quote (132617) and a grand-child quote (132618) and a great-grand-child quote (132619) and a great-great-grand-child quote (132620) and a great-great-great-grand-child quote (132621) and a great-great-great-great-grand-child quote (132622) and a great-great-great-great-great-grand-child quote (132623) :1. And another child quote (132671) |
| 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. |
| 422 - Unprocessable Entity | | |

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

| Invalid Quote ID | |

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

| Circular reference. For example, the Child of a Parent is also the Parent of the Child. | |

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

| The maximum depth is 100. |

GetInclusion

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

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

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 Inclusions: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/inclusion/{inclusion_id}

Parameters (Query Params)

KeyFormatNotesMandatory
inclusion_idstringGet details for a specific Lease Inclusion.No

GetInclusionPlan

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

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

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 InclusionPlans: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/inclusion-plans/{inclusion_plan_id}

Parameters (Query Params)

KeyFormatNotesMandatory
inclusionplanidstringGet details for a specific Lease Inclusion PlanNo

GetInclusionPlans

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

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

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 InclusionPlans: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/inclusion-plans

Parameters (Query Params)

KeyFormatNotesMandatory
inclusion_codestringLimit results to Lease Inclusion Plans for a specific Lease Inclusion CodeNo
inclusionplancodestringLimit results to a specific Lease Inclusion Plan Code.No
includeinactiveflagstringOnly active Inclusion Plans are shown by defaults. To expand the list to include 'inactive' plans set this to yes.No
pagestringSkip to a specific page of results.No
page_sizestringNumber of records to return per page.No

GetInclusions

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

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

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 Inclusions: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/inclusions

Parameters (Query Params)

KeyFormatNotesMandatory
inclusion_codestringGet a list of Lease Inclusions.No
edit_flagstringLimit results to those Lease Inclusions based on their edit_flag.No
providerstringLimit results to those Lease Inclusions based on their provider (Supplier).No
pagestringSkip to a specific page of results.No
page_sizestringNumber of records to return per page.No

GetInsuranceLoadingType

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

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote / Insurance

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 InsuranceLoadingTypes: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/insurance-loading-types/{insurance_loading_type_id}

Parameters (Path Variable)

KeyFormatNotesMandatory
insuranceloadingtype_idstringReturns the details of a specific Insurance Loading Type.No

GetInsuranceLoadingTypes

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

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote / Insurance

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 InsuranceLoadingTypes: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/insurance-loading-types

Parameters (Query Params)

KeyFormatNotesMandatory
loading_typestringGet a list of Insurance Loading Types for a specific Loading Type. Choose from 'pastclaims', 'licence' or 'driverrestrictions'.No
pagestringSkip to a specific page of results.No
page_sizestringNumber of records to return per page.No

GetInsuranceType

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

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote / Insurance

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 InsurerLocations: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/insurer-locations/:insurance_type_id

Parameters (Path Variable)

KeyFormatNotesMandatory
insurancetypeidstringReturns the details of a specific Insurance Type.No

GetInsuranceTypes

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

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote / Insurance

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 InsurerLocations: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/insurer-locations

Parameters (Query Params)

KeyFormatNotesMandatory
insurancetypecodestringGet a list of Insurance Types for a specific Type code (e.g. STD, HP etc).No
type_categorystringGet a list of Insurance Types for a specific type category (depends on your set up).No
highperformanceflagstringGet a list of High Performance flagged Insurance Types.No
pagestringSkip to a specific page of results.No
page_sizestringNumber of records to return per page.No

GetInsurerLocation

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

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote / Insurance

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 InsurerLocations: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/insurer-locations/:insurer_location_id

Parameters (Query Params)

KeyFormatNotesMandatory
insurerlocationidstringReturns the details of a specific Insurance Location.No