GET /api/apis/versions/{APIVersionID}/viewers

Returns a list of viewers (groups) that can view the specified API.

Note: This operation returns groups, not individual users. Once you have the list of groups you can use the Group IDs to get a list of individuals in the groups, if needed, using an operation in the Groups service (getGroupMembers, not yet documented).

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apis/versions/{APIVersionID}/viewers

Sample Request

The example below shows a request for information about the viewers for the specified API version.

Sample Request URL 

https://{hostname}/api/apis/versions/apiversion19184.acmepaymentscorp/viewers

Sample request headers 

Accept: application/json
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/json, text/xml, 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
APIVersionID Path string Required The unique ID for a specific API version.

Response

If successful, this operation returns HTTP status code 200, with information about the private viewers for the API version in the form of an RSS feed (JSON or XML).

Sample Response

The sample response below shows that there are three groups that can view this private API.

Sample response headers: application/json 

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 14 Feb 2013 22:54:57 GMT

Sample response body: application/json 

{
  "channel" : {
    "title" : "Private Viewers",
    "item" : [ {
      "title" : "ND Group ",
      "description" : "group dedicated to design",
      "category" : [ {
        "value" : "group",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "com.soa.group.type.independent",
        "domain" : "com.soa.group.type"
      }, {
        "value" : "Public",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "group18691.acmepaymentscorp"
      }
    }, {
      "title" : "ACME Payments API UG",
      "description" : "ACME Payments API User Group",
      "category" : [ {
        "value" : "group",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "com.soa.group.type.independent",
        "domain" : "com.soa.group.type"
      }, {
        "value" : "Limited",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "group19212.acmepaymentscorp"
      }
    }, {
      "title" : "ACME Payments API Advanced UG",
      "description" : "User group for ACME Payments API users -- for advanced users.",
      "category" : [ {
        "value" : "group",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "com.soa.group.type.independent",
        "domain" : "com.soa.group.type"
      }, {
        "value" : "Limited",
        "domain" : "uddi:soa.com:visibility"
      } ],
      "guid" : {
        "value" : "group19793.acmepaymentscorp"
      }
    } ]
  },
  "version" : "1.0"
}

Response Headers

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

Header Description
Content-Type application/json, text/xml, 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 Private Viewers. Each item in the channel represents a group that can view the Private API version, and includes the information listed below.

Name Description
title Title of the group.
description Description of the group.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example:

"value" : "Public",
"domain" : "uddi:soa.com:visibility"

The example above indicates that the group has a visibility of Public; it is a public group.

In XML the same information is conveyed as follows:

<category domain="uddi:soa.com:visibility">Public</category>
GUID GUID of the group.

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.
404 The resource could not be found. For example, you might get this if you have a typo in the URL, or if the Accept header is set to a wrong value.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.