GET /api/groups/{GroupID}/followers

Returns a list of the users who are following the specified group.

Authorization Roles/Permissions: For a public API, anyone can access this operation. For a Private API, only API Administrators, API Scope Group members and leaders, Site Administrators, and Business Administrators can see the information. The operation will run successfully, but the results are limited by the privacy settings of the resources.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/groups/{GroupID}/followers

Sample Request

The example below shows a request for the followers of the specified group.

Sample Request URL

https://{hostname}/api/groups/group19212.acmepaymentscorp/followers

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Request Parameters

Response

If successful, this operation returns HTTP status code 200, with information about the group's followers. The information is in the form of an RSS channel in JSON format.

Sample Response

The sample response below shows successful completion of this operation. The group has 3 followers.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json

Sample response body (JSON only)

{
  "channel" : {
    "title" : "ACME Payments API UG",
    "description" : "",
    "item" : [ {
      "title" : "Jane Saoirse",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "follow19213.acmepaymentscorp"
      },
      "Action" : {
        "value" : "action.follow.stop",
        "label" : "Stop Following"
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "Jane Saoirse",
          "Guid" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    }, {
      "title" : "Jonathan Swift",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "follow24556.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "Jonathan Swift",
          "Guid" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    }, {
      "title" : "Jennifer Meadows",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "follow24555.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/54855681-ba54-43f0-bc76-a300c4772b8b.png"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "Jennifer Meadows",
          "Guid" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Response Headers

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

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 the title of the resource for which followers are being listed; in this case, the name of the group. Each item in the channel represents one follower, and includes the information listed below.

"value" : "action.follow.stop",
"label" : "Stop Following"

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.

More information about Akana API Platform API error messages.

Related Topics