Cloud Fax and Notifications API 2.6 Documentation
JobDocumentTransmit
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobDocumentTransmit  

26.4 Web Services Push (WSDA) Usage

JobDocumentTransmit Overview

EasyLink offers a "webservice push" delivery capability (commonly used to deliver received faxes) that transmits documents to a user-provided webservice that supports a version of the JobDocumentTransmit async result webservice, as defined in this WSDL, which defines the async result function using the http://premconn.premiereconnect.com/JobDocumentTransmit/2008/10 namespace. This capability is also sometimes called "WSDA" (Web Services Delivery Agent).

The Cloud Fax and Notifications API will process JobDocumentTransmit requests in that namespace, and if used in asynchronous mode, can call the same result-receiving webservice. This means that the Cloud Fax and Notifications API might be usable to recover data that might have been lost due to an error in receiving the results from the webservice push (WSDA) feature. However, while both requests conform to the same schema, there are some variations in how data is presented in the request. Additionally, WSDA provides various fields that ordinarily have to be specifically requested in an JobDocumentTransmitRequest sent to the Cloud Fax and Notifications API.

Extension Element WSDA Extension "name" WSDA Property "name" EasyLink API Extension "name" EasyLink API Property "name"
JobDocumentDataExtension Default UserAccountNumber USER USER
Default Subject USER orig_email_subject
Default OrigFromAddress USER orig_email_from
Default StartTime
WSDA formats this value as an xs:dateTime value, e.g.
"2012-11-04T13:05:45Z"
USER start_time
The API returns this value in the format M/D/YY hh:mm:ss zzz , e.g.
"11/4/12 8:05:45 ET"
Default EntryTime
WSDA formats this value as an xs:dateTime value, e.g.
"2012-11-04T13:05:45Z"
USER entry_time
The API returns this value in the format M/D/YY hh:mm:ss zzz , e.g.
"11/4/12 8:05:45 ET"
Default CustomerNumber USER cust_no
Workflow WorkflowOptions workflow options
DocumentInfoExtension   OrigFilename /DocumentInfoExtension in request,
segment in result
filename
Default Barcode /DocumentInfoExtension in request,
segment in result
barcode

segment would be the name of the job header segment associated with the document. Example values are indoc or attachN (where N is 1,2,3...).

The case for characters in the "name" attributes is not significant, and may vary.

WSDA generally will omit a property if it is not present or has no value, while the Cloud Fax and Notifications API will in general return an empty value in that case.

 
    prev  next        Table of Contents  JobDocumentTransmit  
© Copyright 2020 OpenText Corp. All Rights Reserved.
Privacy Policy | Cookie Policy
This information is subject to change. Please check frequently for updates.
Modified October 06, 2020