GET /api/groups/{GroupID}/members
Returns information about the members of the specified group. The information is returned in the form of an RSS channel.
Authorization Roles/Permissions: Must be logged in. Group member, group leader, Admin, Site Admin, or Business Admin
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/groups/{GroupID}/members
Sample Request
The example below shows a request for the group members for the specified group.
Request URL
https://{hostname}/api/groups/group19212.acmepaymentscorp/members
Sample request headers
GET /api/groups/group19212.acmepaymentscorp/members 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 | text/xml or application/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. |
Response
If successful, this operation returns HTTP status code 200, with information about the group members in JSON or XML format.
Sample Response
The sample response below shows information about the members of the specified group.
Sample response headers: application/json
HTTP/1.1 200 OK Content-Type: application/json Date: Sat, 08 Jun 2013 00:42:41 GMT
Sample response body: application/json
{
"channel" : {
"title" : "ACME Payments API UG",
"description" : "ACME Payments API User Group",
"item" : [ {
"title" : "JaneSaoirse",
"description" : "janesaoirse@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.approved",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.admin",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
"Link" : "../acmepaymentscorp#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
}
}, {
"title" : "PhilipPirrip",
"description" : "philip.pirrip@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.approved",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp/avatars/ce76ac4e-02db-47a3-a0d4-1f2e66a6cf3e.png",
"Link" : "../acmepaymentscorp#/user/2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp/details"
}
}, {
"title" : "JonathanSwift",
"description" : "jonathan.swift@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.approved",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.leader",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png",
"Link" : "../acmepaymentscorp#/user/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/details"
}
}, {
"title" : "JaneSaoirse",
"description" : "janesaoirse@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.pending",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
"Link" : "../acmepaymentscorp#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
}
}, {
"title" : "Joshie",
"description" : "joshie@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.approved",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "user24566.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/user24566.acmepaymentscorp/avatars/4fb36039-816b-4225-bf75-49e26351fc54.png",
"Link" : "../acmepaymentscorp#/user/user24566.acmepaymentscorp/details"
}
}, {
"title" : "JenniferMeadows",
"description" : "jennifer.meadows@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.pending",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png",
"Link" : "../acmepaymentscorp#/user/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/details"
}
}, {
"title" : "HiremP",
"description" : "hpawnitoff@acmepaymentscorp.com",
"category" : [ {
"value" : "com.soa.group.membership.state.approved",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "user23913.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/user23913.acmepaymentscorp/avatars/47875043-89d4-439a-a7d9-2cb4fe761f0d.png",
"Link" : "../acmepaymentscorp#/user/user23913.acmepaymentscorp/details"
}
}, {
"description" : "emer8008@hotmail.com",
"category" : [ {
"value" : "com.soa.group.membership.state.pending",
"domain" : "uddi:soa.com:status"
}, {
"value" : "com.soa.group.membership.role.member",
"domain" : "uddi:soa.com:role"
} ],
"guid" : {
"value" : "user24563.acmepaymentscorp"
},
"Image" : {
"Url" : "https://{hostname}/api/users/user24563.acmepaymentscorp/avatar",
"Link" : "../acmepaymentscorp#/user/user24563.acmepaymentscorp/details"
}
} ]
},
"version" : "1.0"
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | text/xml or application/json |
Response Body
The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The RSS channel includes title, which is the GroupID of the group for which member information is being returned, and description, which is the text description of the group. Each item in the channel represents one group member, and includes the information listed below.
Note: Many of the values returned in the RSS channel correspond to values in the Membership object in the Groups service, as noted below.
| Name | Description |
|---|---|
| title | The group member's username (UserName in the Membership object). |
| description | The group member's email address (Email in the Membership object). |
| category |
An array of sets of name/value pairs containing information about the group member. For example: "value" : "com.soa.group.membership.state.approved", "domain" : "uddi:soa.com:status" The example above indicates the user's group membership state (State in the Membership object). "value" : "com.soa.group.membership.role.admin", "domain" : "uddi:soa.com:role" The example above indicates the user's role in the group (Role in the Membership object). |
| guid | The unique ID for the item; in this case, the group member's UserID (UserID in the Membership object). |
| Image |
Information about the avatar set up for the user; a set of two name/value pairs, URL and Link. If the user hasn't uploaded an image, the URL to the default user image is included. An example is shown below. "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
"Link" : "../acmepaymentscorp#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
|
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.
