Therefore Web API Programming Interface 1.0

Element Name

Element Type

Restrictions

Description

â–  parameters

â–¡ CheckInComments

xs:string

nillable

The Check-in comment.

â–¡ ConversionOptions

mandatory nillable

Specifies options to convert the files.

â–  AnnotationMode

restriction enum (xs:string)

- Default (0)

- Merge (1)

- Hide (2)

Sets the annotation mode.

â–¡ CertificateName

xs:string

nillable

Sets the name of the certificate for signing the file.

â–  ConvertTo

restriction enum (xs:string)

- Original (0)

- SingleTIFF (1)

- SinglePDF (2)

- MultipageTIFF (3)

- MultipagePDF (4)

- SearchablePDF (5)

- SearchablePDFA (6)

- Jpeg (50)

Sets the conversion file format. Notes for multipage conversion types: - In the CreateDocument, AddStreamToDocument, and SubmitCreateDocumentBatch methods, the conversion type will be applied to all the specified streams together. - In the UpdateDocument and SubmitUpdateDocumentBatch methods, the conversion type will be applied to all the new streams together. But for updated streams this will be done on a one by one basis.

â–  SignatureMode

restriction enum (xs:string)

- NoSignature (0)

- SignatureOnly (1)

- SignatureAndTimestamp (2)

Sets the signature mode.

â–¡ TimeStampPwd

xs:string

nillable

Sets the password for the user for the timestamp server.

â–¡ TimeStampServer

xs:string

nillable

Sets the name of the timestamp server for signing the file.

â–¡ TimeStampUser

xs:string

nillable

Sets the user for the timestamp server.

â–¡ MultipageStreamName

xs:string

nillable

Sets the name of the multipage result stream. Specifies a stream name to be used instead of default one (given by conversion server). Use it with multipage conversion types (see the ConvertTo parameter). Value will be ignored for a single page TIFF/PDF, JPEG, and Original conversion types. For the GetConvertedDocStreams, GetConvertedDocStreamsRaw methods set desired file name without extension or null for default name (default is document title).

â–  DocNo

xs:int

mandatory

The number of the document to add streams to.

â–¡ StreamsToUpload

mandatory nillable

The streams to update/add for the document.

≡ WSStreamInfoWithData

list nillable

â–¡ FileData

xs:base64Binary

nillable

Gets or sets binary data of the file. It uses a base64 encoded string in XML messages and a byte array in JSON messages. If both FileData and FileDataBase64JSON are set the value in FileDataBase64JSON gets ignored.

â–¡ FileName

xs:string

mandatory nillable

Gets or sets the name of the stream file.

â–¡ StreamNo

xs:int

nillable

Gets or sets the number of the stream. Note: For document conversion result it always returns null (method GetConvertedDocStreams).

â–¡ FileDataBase64JSON

xs:string

nillable

Gets or sets binary data of the file as a base64 encoded string (for both XML and JSON encoded messages). If both FileData and FileDataBase64JSON are set the value in FileDataBase64JSON gets ignored.

â–¡ FileUploadSessions

nillable

Represents list of file upload sessions to be used to store files within the document. See the UploadSessionStart and UploadSessionAppendChunk methods for more details.

≡ WSStreamInfoUploadSessionData

list nillable

â–¡ FileName

xs:string

mandatory nillable

Gets or sets the name of the stream file.

â–¡ StreamNo

xs:int

nillable

Gets or sets the number of the stream.

â–  UploadSessionId

xs:string

mandatory

GUID string template:

[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

Gets or sets id of the upload session for content of the given file.

Element Name

Element Type

Restrictions

Description

â–  parameters

â–  StreamNo

xs:int

The current StreamNo.

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.