Send a fax job request (sendJobRequest)

TEXT

POST /{custNr}/fax

Description

This method is used to prepare fax jobs to be transferred for processing. If a valid FaxJobRequest has been received by the Webservice, the Webservice sends a Job ID back that must be specified by the client when querying the job status.

When scheduling a fax job, it is necessary to include the time zone in the "start" timestamp. The time zone must be provided following the corresponding ISO 8601 expression, else you will get HTTP status code 400 (see also the JobValid schema).

Parameters

Type

Name

Description

Schema

Path

custNr

required

Your Retarus Customer Number (e.g. 99999TE).

string

Body

requestBody

required

Request parameters as a FaxJobRequest object

FaxJobRequest

Responses

HTTP code	Description	Schema
200	OK: The service has enqueued the job and you are awaiting callback	FaxJobResponse
201	CREATED: Send job successful	FaxJobResponse
400	BAD_REQUEST: Client authorization is missing or unable to process JSON	No Content
404	NOT_FOUND: No job report available for the given jobId; no recipient report available for the given jobId	No Content
409	CONFLICT: Duplicate job	No Content
500	INTERNAL_SERVER_ERROR: Cannot accept job, cannot query jobReport, cannot list jobs, cannot query recipient report, cannot apply transliteration in the send job	No Content
520	UNKNOWN_ERROR: Server signals that there was an unknown problem, most likely with the backend adaptor	No Content

Example HTTP request

JSON

{
   "reference":{
      "customerDefinedId":"2018-08-7T11:04:37.057Z_customerDefinedId",
      "billingCode":"2018-08-7T11:04:37.057Z_billingCode",
      "billingInfo":"2018-08-7T11:04:37.057Z_billingInfo"
   },
   "recipients":[
      {
         "number":"0012012051598",
         "properties":[
            {
               "key":"key123",
               "value":"value123"
            }
         ]
      }
   ],
   "documents":[
      {
         "name":"test-document-inline-byte-array.txt",
         "charset":"UTF-8",
         "data":"SGVsbG8sIHRoaXMgaXMgYSB0ZXN0aW5nIGRvY3VtZW50IGJvZHkgY3JlYXRlZCBmb3IgOTk5OTlURQ=="
      },
      {
         "name":"test-document-by-reference.txt",
         "charset":"UTF-8",
         "reference":"http://mydomain.retarus.com/my-path/mydocument.pdf"
      }
   ],
   "transportOptions":{
      "csid":"test-csid",
      "isExpress":true,
      "isBlacklistEnabled":true
   },
   "renderingOptions":{
      "paperFormat":"A4",
      "resolution":"HIGH",
      "coverpageTemplate":"coverpage-default.ftl.html",
      "header":"%tz=CEST Testfax: CSID: %C Empfaengernummer: %# Datum: %d.%m.%Y %H:%M
%z"
   },
   "statusReportOptions":{
      "reportPurgeTs":"2018-11-03T20:14:37.098+02:00",
      "reportMail":{
         "successAddress":"john.doe@retarus.com",
         "failureAddress":"jane.doe@retarus.com",
         "attachedFaxImageMode":"SUCCESS_ONLY",
         "attachedFaxImageFormat":"TIFF"
      },
      "httpStatusPush":{
         "targetUrl":"http://retarus.com/test-path/test-target",
         "authMethod":"NONE"
      }
   },
   "meta":{
      "customerReference":"99999TE",
      "jobValid":{
         "start":"2018-10-20T15:44:22.349Z",
         "end":"PT90M"
      }
   }
}