Cloud Fax and Notifications API 2.4 Documentation
JobSubmit		Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobSubmit  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

31.2.1 DocumentType

A Document represents a single document, along with information about the document. It does not indicate how the document is to be used. Note that the DocData element is actually a type that is used in other situations where a document is transferred. Also note that most kinds of documents will need to be base64-encoded for inclusion in the XML requests.

This DocumentType definition differs slightly from that used in various other functions, in that the Filename may include characterset information.


Tag Name
& type		#Description
DocumentType    
   @ref
xs:string		0-1This is an arbitrary string that may be used to identify and refer to the document in other parts of a request, for example, a Message element in a JobSubmitRequest may use a Document in a DocumentSet via a DocRef child element. To be used in this way, the ref attribute must be present and must be unique within an Cloud Fax and Notifications API request body.
   DocType
xs:string		1Indicates the format of the document. There are a limited number of legal values. The Cloud Fax and Notifications API will determine if the document indicated for any particular use is of an appropriate type, and generate an error response if it is not. Legal types currently are:
ValueDescription
BMP.bmp image
emptydocument with no content
GIFGIF image file
HTMLHyper Text Markup Language
HTMLLITEThe simplified version of Hyper Text Markup Language (aimed at AOL recipients)
JPEGJPEG image file
MPPMicrosoft Project file
MSWMicrosoft Word
PCLHP Printer Control Language
PDFAdobe Portable Document Format
PNGPNG image file
PPTPowerPoint document
PSPostScript
PUBMicrosoft Publisher document
RTFRich Text Format
textdata to be treated as text
TIFFTagged Image File Format input
unspecIn some cases the file format is unimportant, e.g. for e-mail attachments.
VSDVisio document
WAVWAV/RIFF audio data
XARStandard UNIX ar archive
XLSMicrosoft Excel Spreadsheet
XMFXMF input
   Filename
EncodableStringType		0-1This contains a string to be used wherever the filename of the document may be required. It is not necessarily the actual name of any file that contains the document. In general, the document type will be determined by the DocType value, but for some email processing, the extension part of the Filename value may be used to determine MIME types.
This is an EncodableStringType element, which means that arbitrary character set data can be used by base64-encoding the value, and including a b64charset attribute. The EasyLink switch does not currently use the character set information, and the caller should ensure that the decoded value is appropriate for the usage, for instance it may matter that it be consistent with the job character set value.
   DocData
DocDataType		1This choice is used to contain the actual document contents.
   @format
DocEncodingFormat		1Indicates the format of the data in the XML and may have one of these values:
textif the document is present as plain text, or
base64if it is present as base-64 encoded data
(base64 is likely to be the most common)
DocCfs
xs:string		1This choice is used to refer to a document in the Customer File Store that is to be the source of the document.
DocUrl
xs:anyURI		1This choice is used to refer to a document via a URL which will be used to retrieve the actual document. (Beware of possible access difficulties.)
SosObject
SosObjectIdType		1This choice is used to refer to a document stored as a Stored Object
   @sosType
xs:string		1Indicates the stored object type. Currently supported stored object types are:
ttsText-to-Speech template
vcsVoice Control Script
   @ownershipLevel
OwnershipLevelType		0-1Optional attribute indicating the ownership level of the stored object. Currently supported levels are:
userthe stored object belongs to the user
customerthe stored object belongs to the customer;
groupthe stored object belongs to the group
systemthe stored object is available to everyone.
   CharacterSet
xs:string		0-1The ISO name of the character set used by the document
 
    prev  next        Table of Contents  JobSubmit  
© 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