Get Quote Endpoints: GetDealerOrder

GetDealerOrder

This API replicates the system function of printing a Dealer Order form.

This form can be created in xml, xlsx and csv format, dependant on your system set up.

You can discuss this requirement with your Account Manager.

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 and Quotes:getDealerOrder.

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/quotes/{quote_id}/dealer-order

Parameters - Path

Parameters - Headers

Response Details

{ "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. |
| 406 - Cannot honor Accept type specified | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Cannot honor Accept type specified"}

| You have passed an unsupported or invalid Accept header |
| 422 - Unprocessable Entity | | |

{ "validationMessages": { "quote_id": { "Required field is not provided"}

| Quote ID is missing. This is a mandatory field and must be provided. | |

{ "validationMessages": { "quote_id": { "errorIdentifyingContract": "Error identifying a valid contract from the supplied quote id"}

| The Quote ID entered is linked to multiple contracts or not valid. This form cannot be created where the Quote ID is linked to more than one Contract ID. | |

{ "validationMessages": { "quote_id": { "requiredPermission": "The user associated with the gb::html2pdf_service_login credential is missing the WebServices API permission"}

| Your role as the authenticated user must have the WebServices and Quotes:getDealerOrder permissions enabled, but additionally the ) user must also have those permissions enabled. Go to Roles / APIs and enable the required permissions. |

GetMaintenanceServiceProfiles

Supporting API for patchQuote).
Returns a list of Maintenance details as seen in the Maintenance (MAINT) profile.

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

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 MaintenanceServiceProfiles: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/maintenance-service-profiles

Parameters (Query Params)

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.