Cloud Fax and Notifications API 2.6 - Common Types and Elements

Cloud Fax and Notifications API 2.6 Documentation
Common Types and Elements

Cloud Fax and Notifications API Forums Home

prev next Table of Contents Common Elements

3.7 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.

Tag Name
& type

Description

DocumentType

@ref
xs:string

0-1

This is an arbitrary string that may be used to identify and refer to the document in other parts of a request. To be used in this way, the ref attribute must be present and must be unique within a request body.

DocType
xs:string

Indicates 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:

Value	Description
BMP	.bmp image
empty	document with no content
GIF	GIF image file
HTML	Hyper Text Markup Language
HTMLLITE	The simplified version of Hyper Text Markup Language (aimed at AOL recipients)
JPEG	JPEG image file
MPP	Microsoft Project file
MSW	Microsoft Word
PCL	HP Printer Control Language
PDF	Adobe Portable Document Format
PNG	PNG image file
PPT	PowerPoint document
PS	PostScript
PUB	Microsoft Publisher document
RTF	Rich Text Format
SMF	SMF (EasyLink Standard Message Format) input
text	data to be treated as text
TIFF	Tagged Image File Format input
unspec	In some cases the file format is unimportant, e.g. for e-mail attachments.
VSD	Visio document
WAV	WAV/RIFF audio data
XAR	Standard UNIX ar archive
XLS	Microsoft Excel Spreadsheet
XMF	XMF input

These are not necessarily the same as the filename extension - for example "MSW" is typically used for ".doc" and ".docx" files.

Filename
xs:string

0-1

This 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.

DocData
DocDataType

This choice is used when the actual document content is present in the XML request.

@format
DocEncodingFormat

Indicates the format of the data in the XML and may have one of these values:

text	if the document is present as plain text, or
base64	if it is present as base-64 encoded data

(base64 is likely to be the most common)

DocCfs
xs:string

This choice is used to refer to a document to be retrieved from the Customer File Store. The value should be the full file path of the desired document, relative to the requester's root CFS directory.

DocUrl
xs:anyURI

This choice is used to refer to a document via a URL to be used to retrieve the actual document. (Beware of possible access difficulties.)

SosObject
SosObjectIdType

This choice is used to refer to a document stored as a Stored Object

@sosType
xs:string

Indicates the stored object type. Currently supported stored object types are:

tts	Text-to-Speech template
vcs	Voice Control Script

@ownershipLevel
OwnershipLevelType

0-1

Optional attribute indicating the ownership level of the stored object. Legal level values are:

user	the stored object belongs to the user
customer	the stored object belongs to the customer;
group	the stored object belongs to the group
system	the stored object is available to everyone.

CharacterSet
xs:string

0-1

The ISO name of the character set used by the document

prev next Table of Contents Common Elements

This information is subject to change. Please check frequently for updates.
Modified October 06, 2020