Method deleteFaxReport

This method is used to delete a fax job’s report data. The length of time report data can be stored in the Retarus infrastructure can be individually configured for each time the Webservice is accessed. The default value is 3 days. Once this period elapses, the report data is automatically deleted.

📌 Deleting fax jobs sent via high availability URLs

If you sent fax job requests using a high availability (HA) URL, you must send a delete request to both included data centers. Otherwise, it is likely that the job was not processed in the data center you referenced and cannot be deleted there.

Do not send delete requests directly to an HA URL; always use the specific URLs for each data center.

Input parameter: DeleteReportRequest
Output parameter: DeleteReportResponse

DeleteReportRequest

jobId
Job ID for the job whose report is to be deleted

DeleteReportResponse

jobId
Job ID for which the deletion of report data has been requested

deleted
true is displayed when the deletion has successfully occurred; otherwise, false is displayed

Java sample code

DeleteReportRequest deleteReportRequest = this.objectFactory.createDeleteReportRequest();

// Authentication:
deleteReportRequest.setUsername(_USERNAME_);
deleteReportRequest.setPassword(_PASSWORD_);

// Specify job:
deleteReportRequest.setJobId(_A_JOB_ID_);

// Fire request:
DeleteReportResponse deleteReportResponse = this.servicePort.deleteFaxReport(deleteReportRequest);

System.out.println("Report data for job " + deleteReportResponse.getJobId() + " was deleted successfully");

Request XML

<ns2:DeleteReportRequest xmlns:ns2="http://retarus.com/fax4ba/faxws/3/0">
	<username>faxws@example.com</username>
	<password>faxws</password>
	<jobId>FJHAL0RNBW0AZ82ZX5FCET</jobId>
</ns2:DeleteReportRequest>

Response XML

<ns2:DeleteReportResponse xmlns:ns2="http://retarus.com/fax4ba/faxws/3/0">
	<jobId>FJHAL0RNBW0AZ82ZX5FCET</jobId>
	<deleted>true</deleted>
</ns2:DeleteReportResponse>

Exceptions

TemporaryFailure
appears when the request currently cannot be processed due to an internal Webservice error.

WrongUserPassword
appears when the request contains invalid authentication data.

NotAvailable
appears when there is no report in the system for the job whose ID you specified.