ExecuteReportWebService Reg Renewals

These APIs allow you to run reports available in the Fleet / Administration / Reports menu.

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

Setup

Go to Setup / Reference Data > gb_controls and find the "api_web_services_wrapper_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.

ExecuteReportWebService Reg Renewals

Runs the Registration Renewals Report available in the Fleet / Administration / Reports menu.

URL

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

Body (JSON)

JSON	Field	Format Notes	Mandatory
report_path	string	The coded path: "/core/fleet/reports/pdf_reg_renewals.phpo"	Yes
report_format	string	Report format: PDF (default), Text(CSV), or ExcelXml	Yes
date_filter	date	Only contracts commencing on or prior to this date; contracts suspended on or prior excluded	Yes
t11.user_login	string	Manager field - user login or "--All--" for unfiltered	Yes
t6.client_group_code	string	Group field - client group code or "--All--"	Yes
t3.client_code	string	Client field - client code or "--All--"	Yes
t1.cost_centre	string	Cost Centre field - cost centre code or "--All--"	Yes
t5.posting_map_code	string	Contract Type field - contract type code or "--All--"	Yes
filter_suspend_date	date	Enter as "00/00/0000"; conditional to operate date_filter	Yes
use_supplied_report_path_flag	string	Arguments field	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

201 Success

A successful response returns all fields in the nominated format.

422 Unprocessable Content

Incorrect report_path:

{ "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" }

Invalid report_format:

{ "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" }

Missing or incorrect parameter:

{ "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" }

Authentication failed:

{ "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 and Response payloads. Warning: Never send user login credentials when sending a ticket request. Catch-e staff have their own credentials for debugging.

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

Runs the Service Overdue Report available in the Fleet / Administration / Reports menu.

URL

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