Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetConvertedDocStreams

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetConvertedDocStreams

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetConvertedDocStreams

Returns file streams of existing Therefore™ document and converts them into the desired format.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetConvertedDocStreams

Element Name	Element Type	Restrictions	Description
■ parameters
□ ConversionOptions		mandatory nillable	Sets the options for converting 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	Sets the number of the document to get streams for.
□ StreamNos		mandatory nillable	Sets stream ids of the streams to get. If the list is empty ALL streams of the document will be converted.
≡ StreamNo	xs:int	list
■ ArchiveConvertedFiles	xs:boolean		Set to true to archive (.zip) files after conversion if any. Default is false.
□ CustomArchiveFileName	xs:string	nillable	Set desired file name without extension or null for default name. For a single document default is the document title. For multiple documents default is 'Document'.
■ VersionNo	xs:int		Sets document version number. By default or if set to 0 it means to use the latest document version.
■ IsFileDataBase64JSONNeeded	xs:boolean		Set to true to return file data in the response in the FileDataBase64JSON property (as a Base64 encoded string).

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetConvertedDocStreamsResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ Streams		nillable	Gets list of requested streams converted into the desired format.
≡ 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.
■ 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).

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.