Quote & Lease Operations API: ExecuteReportWebService Reg Renewals

API endpoints for quote (Qt_*) and lease (Qq_*) operations and fleet reports

ExecuteReportWebService Reg Renewals

This API allows you to run the Registration Renewals Report available in the Fleet / Administration / Reports menu.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Web%20Services/executeReportWebService

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control 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

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

URL Examples

https://api.test.catch-e.com/web-services/gb/reporting/executeReport

Body (JSON)

JSON Field	Format	Notes	Mandatory
Query
report_path	string	The coded path that determines which report is run. For "Accidents" use: "/core/fleet/reports/pdfregrenewals.phpo"	yes
report_format	string	This will determine the format the report is created with. The following format is available for this report. PDF - will create PDF report. This is the default Text(CSV) - will create a CSV report ExcelXml - will create an Excel(xlsx) report	yes
Parameters
date_filter	date	Only contracts commencing on or prior to this date will be included and contracts suspended on or prior to this date will be excluded.	yes
t11.user_login	string	This is represented in the Fleet Reports screen by the "Manager" field. Select a user login to filter by the nominated user, else use "--All--" to return an unfiltered result.	yes
t6.clientgroupcode	string	This is represented in the Fleet Reports screen by the "Group" field. Nominate one to limit the report selection to the selected "Client Group", else use "--All--" to return an unfiltered result.	yes
t3.client_code	string	This is represented in the Fleet Reports screen by the "Client" field. Nominate one to limit the report selection to the selected "Client", else use "--All--" to return an unfiltered result.	yes
t1.cost_centre	string	This is represented in the Fleet Reports screen by the "Cost Centre" field. Nominate one to limit the report selection to the selected "Cost Centre", else use "--All--" to return an unfiltered result.	yes
t5.postingmapcode	string	This is represented in the Fleet Reports screen by the "Contract Type" field. Nominate one to limit the report selection to the selected "Contract Type", else use "--All--" to return an unfiltered result.	yes
filtersuspenddate	date	Enter date as "00/00/0000". This parameter is conditional to operate the "date_filter" result.	yes
Arguments
usesuppliedreportpathflag	string		no

JSON Example

{ "report_path": "/core/fleet/reports/pdf_reg_renewals.phpo", "report_format": "PDF", "parameters": { "date_filter": "31/01/2025", "t11.user_login": "--All--", "t6.client_group_code": "--All--", "t3.client_code": "--All--", "t1.cost_centre": "--All--", "t5.posting_map_code": "--All--", "filter_suspend_date": "00/00/0000" }, "arguments": { "use_supplied_report_path_flag": "no" }}

Response Details

Validation Messages	Comments
201 Success
	A successful response returns all fields in the nominated format.
422 Unprocessable Content

{ "validation_messages": { "report_path": { "notInArray": "Unsupported report path specified" }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| Incorrect "report_path" has been entered. | |

{ "validation_messages": { "report_format": { "notInArray": "The input was not found in the haystack" }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"

| The "report_path" entered is not in the allowable list of options. | |

{ "validation_messages": { "web_service_error": { "CATCH_E_ERROR_NOTHING_TO_REPORT": "" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}|

| A Parameter is missing, or an incorrect value has been entered. | |

{ "validation_messages": { "web_service_error": { "CATCH_E_ERROR_AUTHENTICATION_FAILED": "" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}|

| This response could be due to incorrect authentication credentials, or your authentication token has timed out. If you are consistently receiving this error, please raise a ticket with your Account Manager. Please supply the complete Request & Response payloads. [Warning:] Please remember to NEVER send user login credentials when sending a ticket request. Catch-e staff have our own credentials we can use to de-bug these tickets. |
| 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. |

ExecuteReportWebService Service Overdue

This API allows you to run the Service Overdue Report available in the Fleet / Administration / Reports menu.