Search Results for

    Show / Hide Table of Contents

    Method AddDocumentListNamedToRemoteFolder

    AddDocumentListNamedToRemoteFolder(String, String, List<DocumentIdNameContract>)

    Add a list of documents to a remote folder. The documents references are named according to the names given in the DocumentIdNameContract.

    Declaration
    List<DocumentIdNameContract> AddDocumentListNamedToRemoteFolder(string connectionId, string targetRemoteFolderPath, List<DocumentIdNameContract> documentIdNames)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    System.String targetRemoteFolderPath

    Path of target remote folder. See also Path

    System.Collections.Generic.List<DocumentIdNameContract> documentIdNames

    List of documents which shall be added

    Returns
    Type Description
    System.Collections.Generic.List<DocumentIdNameContract>

    A list of key value pairs (document id - document name) of all created remote folder elements.

    Examples

    POST http://YourServerName/InfoShare/Json/RemoteFolder/AddDocumentListNamedToRemoteFolder

    Example for add a list of documents with specific names to a remote folder.

    {
        "connectionId": "{{connectionId}}",
        "targetRemoteFolderPath": "09d562f5-7073-ec11-a1a9-00155d109000\\e5ad460d-7173-ec11-a1a9-00155d109000\\11e1d275-4274-ec11-a1aa-00155d109000",
        "documentIdNames": [
            {
                "DocumentId": "0c164648-6928-4004-8561-e88dc9a6acc0",
                "DocumentName": "Rechnung_8.pdf"
            },
            {
                "DocumentId": "d7bc2d08-675b-421b-9565-3ee183dacf66",
                "DocumentName": "Rechnung_8.pdf"
            }
        ]
    }

    Response:

    {
        "AddDocumentListNamedToRemoteFolderResult": [
            {
                "DocumentId": "0c164648-6928-4004-8561-e88dc9a6acc0",
                "DocumentName": "Rechnung_8.pdf"
            },
            {
                "DocumentId": "d7bc2d08-675b-421b-9565-3ee183dacf66",
                "DocumentName": "Rechnung_8.pdf"
            }
        ]
    }
    Exceptions
    Type Condition
    ServiceException

    The connection id {connectionId} isn't valid or has expired (10008)

    ServiceException

    Root folder not found (10023)

    ServiceException

    Folder not found {folderPath} (10025)

    ServiceException

    No document found for documentId {documentId} (10005)

    ServiceException

    Verification code is needed: Verification code not yet verified (10152)

    ServiceException

    Document {documentId} is already an element of folder {folderId} (10266)

    Back to top Copyright © Kendox