Method StartFileTransactionInfoConverted

StartFileTransactionInfoConverted(String, String, String, String, String, String, String, Boolean, Boolean)

Starting a new file transaction converted. Download the file with the method GetTempFile. Call ReleaseFile to end transaction.

Declaration

FileTransactionResultContract StartFileTransactionInfoConverted(string connectionId, string documentId, string versionId, string documentDataId, string renditionId, string accessTypeEnum, string targetFormat, bool addAnnotations, bool addOverlay)

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
System.String	targetFormat	The target format (e.g. "pdf")
System.Boolean	addAnnotations	Include annotations
System.Boolean	addOverlay	Include overlays

Returns

Type	Description
FileTransactionResultContract	Returns the file id and several input parameters.

Examples

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

A simple example for start file transaction info converted.

{
   "connectionId": "bbf760ba-6bdb-45b6-9eec-992669fc7359",
   "documentId": "653fa7fd-f6dd-e911-a947-00155d290a08",
   "versionId": "653fa7fd-f6dd-e911-a947-00155d290a08",
   "documentDataId": "",
   "renditionId": "",
   "targetFormat": "pdf",
   "addAnnotations": false,
   "addOverlay": false
}

Response:

{
    "StartFileTransactionInfoConverted": {
        "DocumentDataId": null,
        "DocumentId": "653fa7fd-f6dd-e911-a947-00155d290a08",
        "FileId": "9a4a15eb-acd1-4399-a160-c4169cc6f2d8",
        "RenditionId": null,
        "VersionId": "653fa7fd-f6dd-e911-a947-00155d290a08"
    }
}

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	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)
ServiceException	BlobStore {blobStoreId} is not available (10171)
ServiceException	Could not get file stream: {errorMessage} (10172)