GET /api/apps/{AppID}/members

Returns information about team members for the specified app.

Authorization Roles/Permissions: App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apps/{AppID}/members

Sample Request

The example below requests the team members for app10021.

Sample request URL

https://{hostname}/api/apps/app10021.acmepaymentscorp/members

Sample request headers

GET /api/apps/app10021.acmepaymentscorp/members HTTP/1.1
Host:{hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/xml, text/xml, application/json application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml application/vnd.soa.v81+json, application/vnd.soa.v81+xml
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
AppID	Path	string	Required	The unique ID for a specific app.

Response

If successful, this operation returns HTTP status code 200, with information about the team members in an RSS channel formatted as JSON or XML.

Sample Response

The sample JSON response below is for a team that has three members.

Sample response headers

HTTP/1.1 200 OK
Date: Tue, 24 Jul 2012 16:10:58 GMT
Content-Type: application/json

Sample response body

{
  "channel" : {
    "title" : "Application team members",
    "item" : [ {
      "title" : "JonathanSwift",
      "description" : "marymead@acmepaymentscorp.com",
      "category" : [ {
        "value" : "com.soa.group.membership.state.pending",
        "domain" : "uddi:soa.com:status"
      } ],
      "guid" : {
        "value" : "user10016.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "users/user10016.acmepaymentscorp/picture",
        "Link" : "../acmepaymentscorp#/user/user10016.acmepaymentscorp/details"
      }
    }, {
      "title" : "PhilipPirrip",
      "description" : "janesaoirse@acmepaymentscorp.com",
      "category" : [ {
        "value" : "com.soa.group.membership.state.pending",
        "domain" : "uddi:soa.com:status"
      } ],
      "guid" : {
        "value" : "user10017.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "users/user10017.acmepaymentscorp/picture",
        "Link" : "../acmepaymentscorp#/user/user10017.acmepaymentscorp/details"
      }
    }, {
      "title" : "JaneSaoirse",
      "description" : "jane.saoirse@example2.com",
      "category" : [ {
        "value" : "com.soa.group.membership.state.approved",
        "domain" : "uddi:soa.com:status"
      } ],
      "guid" : {
        "value" : "user10015.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "users/user10015.acmepaymentscorp/picture",
        "Link" : "../acmepaymentscorp#/user/user10015.acmepaymentscorp/details"
      }
    } ]
  },
  "version" : "1.0"
}

Response Headers

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

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

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 title of the RSS channel is Application Team Members. Each item in the channel represents one team member, and includes the information listed below.

Name	Description
Title	Username of the team member.
description	Email address of the team member.
category	An array of name/value pairs indicating the user's category, including status (for example, com.soa.group.membership.state.pending) and domain (for example, uddi:soa.com:status).
guid	The unique ID for the item; in this case, the UserID of the team member.
Image	A URL to the user's image, if set up. If the user hasn't uploaded an image, the URL to the default user image is included.

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.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics