Method getListOfAvailableFaxReports
This method is used to query available fax reports for completed fax jobs. This request contains no entries other than the authentication data. In response to the query, an element from the AvailableReport type is on hand for each report. Other than the Job ID, information on the time of creation, and, when available, the completion time for the job, are contained in the report.
If you sent the fax job requests via a high availability URL, you have to poll the status from both included data centers. E.g., US1 and US2 in case of the US high availability URL. Please do not poll statuses directly from an HA URL but use the specific ones for the data centers.
The results are limited to the oldes 1000 entries. It is recommended to delete the status reports after fetching them in order to retrieve the following ones.
Input parameter: AvailableReportsRequest
Output parameter: AvailableReportsResponse
AvailableReportsResponse
Field name | Data type | Required | Multiple possible |
---|---|---|---|
AvailableReport | No | Yes | AvailableReport |
availableReport
Job-ID with timestamp: created + finished
If a finished timestamp is available: transmission is complete.
If there is no finished timestamp: the status is PENDING.
Java sample code
AvailableReportsRequest availableReportsRequest = this.objectFactory.createAvailableReportsRequest();
// Authentication:
availableReportsRequest.setUsername(_USERNAME_);
availableReportsRequest.setPassword(_PASSWORD_);
// Fire request:
AvailableReportsResponse availableReportsResponse = this.servicePort.getListOfAvailableFaxReports(availableReportsRequest);
// Analyse response:
System.out.println("There are reports available for the following jobs:");
for (AvailableReport availableReport : availableReportsResponse.getAvailableReport()) {
System.out.println(availableReport.getJobId() + "; Created: " + availableReport.getCreatedTS() + "; Completed: " + availableReport.getFinishedTS());
}
Request XML
<ns2:AvailableReportsRequest xmlns:ns2="http://retarus.com/fax4ba/faxws/3/0">
<username>faxws@example.com</username>
<password>faxws</password>
</ns2:AvailableReportsRequest>
Response XML
<ns2:AvailableReportsResponse xmlns:ns2="http://retarus.com/fax4ba/faxws/3/0">
<availableReport>
<jobId>FJHAL1LLR70AZ82ZX57ITZ</jobId>
<createdTS>2015-12-11T14:04:50.274+01:00</createdTS>
</availableReport>
<availableReport>
<jobId>FJHAL0RNBW0AZ82ZX5FCET</jobId>
<createdTS>2015-12-11T13:41:32.635+01:00</createdTS>
<finishedTS>2015-12-11T13:57:02+01:00</finishedTS>
</availableReport>
</ns2:AvailableReportsResponse>
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.
AvailableReport
Job ID and timestamp when a report is available for the job.
Field name | Data type | Required | Multiple possible |
---|---|---|---|
jobId | String | Yes | No |
createdTS | Date | Yes | No |
finishedTS | Date | No | No |
jobId
Job ID (fax ID)
createdTS
time the job was created
finishedTS
time processing of the job ended