Search Results for

    Show / Hide Table of Contents

    Method SetReadReceipt

    SetReadReceipt(String, String, Boolean)

    Add current user to read receipt list and remove current user from reading list, if hasRead is true. Remove current user from read receipt list and add current user to reading list, if hasRead is false.

    Declaration
    void SetReadReceipt(string connectionId, string documentId, bool hasRead)
    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.Boolean hasRead

    true if current user read document, or false if current user did not read it

    Remarks

    You need "CheckOut" access right. See also AccessRightsEnum

    Examples

    POST http://YourServerName/InfoShare/Json/Document/SetReadReceipt

    Example for add current user to read receipt list and remove current user from reading list.

    {
       "connectionId": "1fbe116a-20a9-4378-b198-6cf3283f0238",
       "documentId": "7d58533d-75db-e911-a946-00155d290a08",
       "hasRead": false
    }

    Response:

    { }
    Exceptions
    Type Condition
    ServiceException

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

    ServiceException

    No document found for documentId {documentId} (10005)

    ServiceException

    Not enough rights ({accessOperationName}, {accessOperationId}) (10071)

    ServiceException

    Property type not found {propertyTypeId} (10034)

    ServiceException

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

    Back to top Copyright © Kendox