GET /api/groups/{GroupID}

Returns a summary of information about the specified group.

Authorization Roles/Permissions: Must be logged in. To complete this operation successfully, a user must be a group member or have other authorization to view the group, such as site admin rights.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/groups/{GroupID}[?IncludeSettings=boolean]

Sample Request

The example below shows a request for information about the specified group, including settings.

Sample Request URL

https://{hostname}/api/groups/group19212.acmepaymentscorp?IncludeSettings=true

Sample request headers

GET /api/groups/group19212.acmepaymentscorp?IncludeSettings=true HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
GroupID	Path	string	Required	The unique ID for a specific group.
IncludeSettings	Query	boolean	Optional	Indicates whether the settings for the resource should be included in the response. If not specified, defaults to false.

Response

If successful, this operation returns HTTP status code 200, with information about the group in JSON format.

Sample Response

The sample response below shows successful completion of this operation. The IncludeSettings parameter is set to true, so information about the group settings is included.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json
Date: Sat, 08 Jun 2013 00:42:41 GMT

Sample response body

{
  "GroupID" : "group19212.acmepaymentscorp",
  "Name" : "ACME Payments API UG",
  "Description" : "ACME Payments API User Group",
  "Tag" : [ "users" ],
  "Visibility" : "Limited",
  "GroupType" : "com.soa.group.type.independent",
  "ContextObjectID" : "apiversion19184.acmepaymentscorp",
  "Created" : "2013-02-06T16:08:24Z",
  "Updated" : "2013-06-14T15:36:02Z",
  "RatingSummary" : {
    "Five" : 1,
    "Four" : 0,
    "Three" : 0,
    "Two" : 0,
    "One" : 0
  },
  "MemberCount" : 5,
  "AdminCount" : 1,
  "IsFollowed" : true,
  "GroupSettings" : {
    "GroupBoardSupport" : "com.soa.feature.enabled",
    "GroupRatingsSupport" : "com.soa.feature.enabled",
    "GroupReviewsSupport" : "com.soa.feature.enabled"
  }
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
Group	Group	Information about the group, including some or all of the following: GroupID, Name, Description, GroupType, ContextObjectID, Link, Contact, Visibility, and Picture.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics