Method DownloadFileConverted

DownloadFileConverted(String, String, String, String, String, String, ConvertingOptionsContract)

Download file converted

Declaration

Stream DownloadFileConverted(string connectionId, string documentId, string versionId, string documentDataId, string renditionId, string accessTypeEnum, ConvertingOptionsContract convertingOptions)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	documentId	The document id. See also Id
System.String	versionId	Optional: The version id. See also GetVersionListItems(String, String, Int32, Int32)
System.String	documentDataId	Optional: The document data id. See also DocumentData
System.String	renditionId	Optional: The rendition id. See also DocumentData
System.String	accessTypeEnum	Optional: Type of access AccessTypeEnum
ConvertingOptionsContract	convertingOptions	Options for converting

Returns

Type	Description
System.IO.Stream	Converted document as stream

Examples

POST http://YourServerName/InfoShare/Json/File/DownloadFileConverted

A simple example download file converted as stream.

{
   "connectionId": "6750c3bd-2f8a-4beb-8f0f-25dc70340d71",
   "documentId": "9e2009e6-0cde-e911-a947-00155d290a08",
   "versionId": "",
   "documentDataId": "",
   "renditionId": "",
   "accessTypeEnum": "",
   "convertingOptions": {
     "TargetFormat": "pdf",
     "StartPage": 0,
     "EndPage": 0,
     "AddAnnotatins": false,
     "AddOverlay": false,
     "PreferImageRendering": false 
    }
}

Example download signature report file as stream.

{
   "connectionId": "6750c3bd-2f8a-4beb-8f0f-25dc70340d71",
   "documentId": "9e2009e6-0cde-e911-a947-00155d290a08",
   "versionId": "9e2009e6-0cde-e911-a947-00155d290a08",
   "documentDataId": "1e2889e6-0cde-e911-a947-00155d290a08",
   "renditionId": "9e2300e6-0cde-e911-a947-00155d290a77",
   "accessTypeEnum": "",
   "convertingOptions": {
     "TargetFormat": "pdf",
     "StartPage": 0,
     "EndPage": 0,
     "AddAnnotatins": false,
     "AddOverlay": false,
     "PreferImageRendering": false 
    }
}

Response:

data:text/html;base64,77u/PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUwgMS4wIFRyYW
5zaXRpb25hbC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFREL3hodG1sMS10cmFuc2l0aW9uYWwuZHRkIj4NCjxodG1sIHhtbG5zPSJodHRwOi8 ...

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Document without file {documentId} (10004)
ServiceException	No document found for documentId {documentId} (10005)
ServiceException	From parameter to high (10009)
ServiceException	Not enough rights ({accessOperationName}, {accessOperationId}) (10071)
ServiceException	Could not retrieve version {versionId} for document {documentId} (10130)
ServiceException	Verification code is needed: Verification code not yet verified (10152)