Method StartFileTransactionInfo

StartFileTransactionInfo(String, String, String, String, String, String, Boolean)

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

Declaration

FileTransactionResultContract StartFileTransactionInfo(string connectionId, string documentId, string versionId, string documentDataId, string renditionId, string accessTypeEnum, bool ignoreHashValidation)

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.Boolean	ignoreHashValidation	Ignore system configuration for hash validation

Returns

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

Examples

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

A simple example for start file transaction info.

{
    "connectionId": "f2df0337-9abd-4264-aab2-2778d4ae9d76",
    "documentId": "c1e7159b-955b-40cc-a9e7-aed9e95c4a25",
    "versionId": "c1e7159b-955b-40cc-a9e7-aed9e95c4a25",
    "documentDataId": null,
    "renditionId": null,
    "accessTypeEnum": "ContentExportForPreview",
    "ignoreHashValidation": false
}

Response:

{
     "StartFileTransactionInfoResult": {
        "DocumentDataId": null,
        "DocumentId": "c1e7159b-955b-40cc-a9e7-aed9e95c4a25",
        "FileId": "9a4a15eb-acd1-4399-a160-c4169cc6f2d8",
        "RenditionId": null,
        "VersionId": "c1e7159b-955b-40cc-a9e7-aed9e95c4a25"
    }
}

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)