REretarus
Fax reports

Delete the status report for a single job

Deletes the status report for a single job. Returns the Job ID.

delete/{custNr}/fax/reports/{jobId}

Request

  • Base URL
    https://faxws.de1.retarus.com/rest/v1
  • Auth
    HTTP basic

Path parameters

custNrstring required

Customer Number

jobIdstring required

Response

Status report deleted

jobIdstring nullable required

The Job ID.

deletedboolean required

Returns true if the job was successfully deleted, false otherwise. If absent in the response it means the job was successfully deleted.

reason'NOT_FOUND' | 'INTERNAL_ERROR'

Missing if deletion was successful, otherwise one of the following reason messages is returned:

  • NOT_FOUND: No report exists for the given job id.
  • INTERNAL_ERROR: Unspecified server-side error.

Example response

{
  "jobId": "FJJ66GHGX105ZZBIELVCN1",
  "deleted": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.