Skip to content

Delete the status report for a single job

Request

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

Security
httpBasicAuth
Path
custNrstringrequired

Customer Number

jobIdstringrequired
curl -i -X DELETE \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax4a-api/{custNr}/fax/reports/{jobId}'

Responses

Status report deleted

Bodyapplication/json
jobIdstring or nullrequired

The Job ID.

deletedbooleanrequired

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

reasonstring

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.
Enum:"NOT_FOUND""INTERNAL_ERROR"
Response
{
  "jobId": "FJJ66GHGX105ZZBIELVCN1",
  "deleted": true
}