GetDealerOrder

Replicates the system function of printing a Dealer Order form. Can be created in XML, XLSX, and CSV format, depending on system setup. Discuss format requirements with your Account Manager.

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

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

Path Parameters

Key	Format	Notes	Mandatory
quote_id	string	Quote ID dealer order is generated for	Yes

Headers

Key	Format	Notes	Mandatory
Time-Zone	string	Time zone name (e.g. Australia/Melbourne)	No

Response - 201 Success

The request was successful. Dealer Order will be created.

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 - 406 Not Acceptable

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

You passed unsupported or invalid Accept header.

Response - 422 Unprocessable Entity

Missing Quote ID:

{ "validation_messages": { "quote_id": { "required_field": "Required field is not provided" } } }

Quote ID is missing. This is mandatory.

Invalid Quote ID (multiple contracts):

{ "validation_messages": { "quote_id": { "error_identifying_contract": "Error identifying a valid contract from supplied quote id" } } }

Quote ID linked to multiple contracts or invalid. Form cannot be created where Quote ID linked to more than one Contract ID.

Missing WebServices permission:

{ "validation_messages": { "quote_id": { "required_permission": "The user associated with gb::html2pdf_service_login credential is missing WebServices API permission" } } }

Your role and the html2pdf_service_login user must have WebServices and Quotes:getDealerOrder permissions enabled. Go to Roles / APIs and enable required permissions.

GetMaintenanceServiceProfiles

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

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

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

Query Parameters

Key	Format	Notes	Mandatory
name	string	Get maintenance_service_profile_id for specific Maintenance / Service Profile. 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.