Search Results for

    Show / Hide Table of Contents

    Method GetGroupForName

    GetGroupForName(String, String, Boolean)

    Get group information of this server

    Declaration
    GroupContract GetGroupForName(string connectionId, string name, bool withDeactivatedAndDeletedUsers)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    System.String name

    The name of group

    System.Boolean withDeactivatedAndDeletedUsers

    Defines with deactivated and deleted users returned

    Returns
    Type Description
    GroupContract

    Get current group

    Examples

    POST http://YourServerName/InfoShare/Json/Common/GetGroupForName

    Example for get group information of this server.

    {
       "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
       "name": "Administration",
       "withDeactivatedAndDeletedUsers": false
    }

    Response:

    {
       "GetGroupForNameResult": {
            "Description": {
                "Values": [
                {
                    "Culture": "de",
                    "Text": "Administration"
                },
                {
                    "Culture": "en",
                    "Text": "Administration"
                } ]
              },
            "DisplayName": "Administration",
            "Domain": "",
            "Id": "2069f7e6-fe3e-ed11-8d62-00155d290a68",
            "Name": "Administration",
            "UserIds": [ "0100a003-38a7-11d8-a902-0050bf427e8f","2e784cd9-fe3e-ed11-8d62-00155d290a68","7e417df3-fe3e-ed11-8d62-00155d290a68","09a7322e-814f-ed11-8d74-00155d290a68","5aff555b-0a51-ed11-8d76-00155d290a68"],
            "SID": "S-1-5-21-515967899-920026266-1708537768-1000"
        }
    }
    Exceptions
    Type Condition
    ServiceException

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

    ServiceException

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

    ServiceException

    Two way authentication type ({twoWayAuthenticationType}) is invalid. Valid types are: {allowedTwoWayAuthenticationTypes} (10148)

    ServiceException

    Could not parse int {flag} to a valid two way authentication type (10154)

    Back to top Copyright © Kendox