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

47.3 QueuedDocumentRetrieveResult

QueuedDocumentRetrieve Overview   QueuedDocumentRetrieveRequest

Tag Name
& type
#Description
QueuedDocumentRetrieveResult   Namespace of this element is http://ws.easylink.com/QueuedDocumentRetrieve/2013/01
   Status
StatusType
1Status of processing. See StatusType.
As long as no error was encountered during processing, the returned Status will indicate success even if no document was found awaiting delivery. (The absence of a JobDocumentData element would indicate that no document was waiting.)
A "partial" StatusCode (2) indicates that no document was found, but that a problem was encountered while checking some of the possible switches. A "success" StatusCode (0) will always be returned if a document is found, although there may be ErrorList items as well.
   SubmitId
xs:string
0-1Echoes the SubmitId in the request, if one was provided, and if possible.
   RemoteId
xs:string
0-1Echoes the RemoteId (if any) from the request.
   QueueId
QueueIdType
0-1This element contains information that identifies the specific switch delivery. This information (along with the JobId) should be preserved and used (without any changes) in a subsequent QueuedDocumentRelease call to complete the delivery and allow switch processing to proceed.
The QueuedDocumentRelease call for a document is expected to be received soon after the QueuedDocumentRetrieve call that retrieved it. If the document is not released, it will eventually be returned to the queue to be available for retrieval again.
   XDN
xs:string
1The domain name.
   QueueName
xs:string
1The name of the delivery queue.
   ItemID
xs:unsignedInt
1An identifier for the delivery queue item.
   JobId
JobIdType
0-1The job to which the document belongs. This information (along with the QueueId) should be preserved and used (without any changes) in a subsequent QueuedDocumentRelease call to complete the delivery and allow switch processing to proceed.
See JobIdType.
   PreviousRetrieval0-1If this particular document has been previously retrieved, this element will be included to provide information about one such prior retrieval.
Retrieving the same item multiple times will only happen if a QueuedDocumentRelease call was not made within the required period to confirm successful receipt. Only information about the most recent prior retrieval is returned.
   ProcessingID
xs:string
1The EMAPI ProcessingID identifying the previous retrieval transaction.
   RemoteId
xs:string
0-1The RemoteId (if any) from the previous retrieval. This value may have been modified to conform to the internal 24 ASCII character restriction.
   UserId
xs:string
0-1User ID associated with the job. This is the system's formal user ID, and not an alias such as a phone number or email address.
%USER:USER_ID value from job header.
   ServiceType
xs:string
0-1The EasyLink system will attempt to associate jobs with various types of service, reflecting the general nature of the job (fax, email, voice, fax-to-mail, etc.). Possible values (case insensitive) include but are not limited to:
F2M M2F FR MR VR SR
%USER:SERVICE_TYPE value, possibly overridden by %FAX2MAIL:SVC value when present.
   CustomerRef
EncodableStringType
0-1The customer reference value
%USER:CREF value from job header.
   BillingCode
EncodableStringType
0-1The billing code
%USER:BC value from job header
   RetrieveRequestExtension
SegmentType
0-Additional information, corresponding to information requested using RetrieveRequestExtension.
   @name
xs:string
0-1The name of the segment. No name is equivalent to the default ("USER") segment. The case of the characters in the value is not significant, and may vary.
   Property1-This element will contain the specific value.
   @name
xs:string
1The name of the property (keyword). The case of the characters in the value is not significant, and may vary.
   @b64charset
xs:string
0-1The value may be base64 encoded to convey data in a particular character set. If this is done, the character set is named in this attribute. See EncodableStringType.
   JobDocumentData0-This element contains information about the document being delivered and its origin. In most cases, there will not be more than one of these.
If this element is not present in the result, it simply means that no document was found waiting to be delivered. The user application should wait a reasonable interval before checking again for delivery.
   TransactionInfo
TransactionInfoType
0-1Contains the transaction information of the document. See TransactionInfoType.
   JobDocumentDataExtension
SegmentType
0-Additional information about the document in key-value pairs. None are currently defined.
   @name
xs:string
0-1The name of the segment. No name is equivalent to the default ("USER") segment. The case of the characters in the value is not significant, and may vary.
   Property1-This element will contain the specific value.
   @name
xs:string
1The name of the property (keyword). The case of the characters in the value is not significant, and may vary.
   @b64charset
xs:string
0-1The value may be base64 encoded to convey data in a particular character set. If this is done, the character set is named in this attribute. See EncodableStringType.
   DocumentInfo
JobDocumentInfoType
0-Contains the document content and information.
   JobDocumentType
xs:string
0-1This element indicates the role of the document in the job.
Deliverythe primary document being delivered
Delivery-Attachmentan attachment to the primary delivery
Reporta report document
Report-Attachmentan attachment for the report
   DocumentNumber
DocumentId
0-1Document number and domain.
   XDN
xs:string
1Domain from which the document was retrieved.
   DocNo
xs:unsignedInt
1Document Number.
   Filename
EncodableStringType
0-1Filename of the document.
   CharacterSet
xs:string
0-1CharacterSet (if any) recorded for the document.
   DocType
xs:string
0-1Format of the document (i.e PDF, XAR, HTML...)
   DocumentInfoExtension
SegmentType
0-More information about the document if requested by user and available. See ExtensionType
   FileData
DocDataType
1Actual document data. See DocData.
 
    prev  next        Table of Contents  QueuedDocumentRetrieve  
© 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