Was this page helpful?

GET:groups/{groupid}

    Overview

    public. Retrieve group information

    Uri Parameters
    NameTypeDescription
    groupidstringeither an integer group ID or "=" followed by a double uri-encoded group name
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Read access is required
    NotFound404Requested group could not be found
    Ok200Request completed successfully

    Message Format

    Output:

    <group id="{int}" href="{uri}">
        <groupname>{text}</groupname> 
        <service.authentication id="{int}" href="{uri}" /> 
        <users count="{int}" href="{uri}" /> 
        <permissions.group>
            <operations mask="{int}">{text}</operations> 
            <role id="{int}" href="{uri}">{text}</role> 
        </permissions.group>
    </group>

    Implementation Notes

    Groups provide the ability to associate a collection of users with a predefined role.  Use GET:site/roles to retrieve a list of all roles currently defined on the site.

    Use GET:groups to retrieve a list of groups defined across the site.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by