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

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

Accept: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.

Back to top

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).

Back to top

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"
}

Back to top

Sample response headers: text/xml

Status Code: 200 OK
Content-Type: text/xml

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns2="http://soa.com/xsd/rss/1.0" xmlns:ns3="http://soa.com/xsd/comment/1.0" 
xmlns:ns4="http://soa.com/xsd/user/1.0" xmlns:ns5="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns6="http://soa.com/xsd/resource/1.0" xmlns:ns7="http://soa.com/xsd/fault/1.0" 
xmlns:ns8="http://soa.com/xsd/api/1.0" xmlns:ns9="http://soa.com/xsd/board/1.0" version="1.0">
  <channel>
    <title>Private Viewers</title>
    <item>
      <title>ND Group</title>
      <description>group dedicated to design</description>
      <category domain="uddi:soa.com:resourcetype">group</category>
      <category domain="com.soa.group.type">com.soa.group.type.independent</category>
      <category domain="uddi:soa.com:visibility">Public</category>
      <guid>group18691.acmepaymentscorp</guid>
    </item>
    <item>
      <title>ACME Payments API UG</title>
      <description>ACME Payments API User Group</description>
      <category domain="uddi:soa.com:resourcetype">group</category>
      <category domain="com.soa.group.type">com.soa.group.type.independent</category>
      <category domain="uddi:soa.com:visibility">Limited</category>
      <guid>group19212.acmepaymentscorp</guid>
    </item>
    <item>
      <title>ACME Payments API Advanced UG</title>
      <description>User group for ACME Payments API users -- for advanced users.</description>
      <category domain="uddi:soa.com:resourcetype">group</category>
      <category domain="com.soa.group.type">com.soa.group.type.independent</category>
      <category domain="uddi:soa.com:visibility">Limited</category>
      <guid>group19793.acmepaymentscorp</guid>
    </item>
  </channel>
</rss>

Back to top

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

Back to top

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.

Back to top

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.
404

The resource could not be found.

For example, you might get this 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.

Back to top

Related Topics