Therefore Web API Programming Interface 1.0

Element Name

Element Type

Restrictions

Description

â–  parameters

â–  BatchId

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}

Sets identifier of the batch.

â–¡ StreamInfoWithData

mandatory nillable

Sets the information and data for an uploaded stream.

â–¡ 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.

â–  NewStreamInsertMode

restriction enum (xs:string)

- Append (0)

- Prepend (1)

Sets insert mode for a new file stream when updating the document. Default is 'Append' (append to the end).

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.