GET /api/boards/{BoardID}/followers

Returns information about the followers of the specified user-defined board, in the form of an RSS feed.

Note: To get the followers for other types of boards, such as an app board, use the applicable operation in that service. See the applicable service index pages for apis, apps, and groups.

Authorization Roles/Permissions: Site Admin or Business Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/boards/{BoardID}/followers

Back to top

Sample Request

The example below shows a request for information about the followers of the Support Board.

Request URL

https://{hostname}/api/boards/supportboard.acmepaymentscorp/followers

Sample request headers

Accept: application/json

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, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BoardID Path string Required The unique ID for a specific user-defined board.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the followers for the specified board.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Mon, 23 Feb 2015 14:38:45 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Support",
    "description" : "",
    "item" : [ {
      "title" : "JaneMead",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "89d43afe-3c18-4dea-ad2e-87f77af126cd.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/a507bc08-4ab0-433b-b517-178f338aadeb.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "JaneMead",
          "Guid" : "a507bc08-4ab0-433b-b517-178f338aadeb.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    }, {
      "title" : "JonathanSwift",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "2baca5fb-ed76-4b93-ab50-fba4d28b131c.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/a1706d56-649c-46f4-8ffd-1e36e8b92d65.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "JonathanSwift",
          "Guid" : "a1706d56-649c-46f4-8ffd-1e36e8b92d65.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    }, {
      "title" : "PhilipPirrip",
      "category" : [ {
        "value" : "user",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "follower",
        "domain" : "uddi:soa.com:relationshiptype"
      } ],
      "guid" : {
        "value" : "4c406a4b-1b4d-442d-a7c2-861c6f00e7a2.acmepaymentscorp"
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/13d5cc4b-eede-483b-91be-cf46ad4f0d7a.acmepaymentscorp/avatar"
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Title" : "PhilipPirrip",
          "Guid" : "13d5cc4b-eede-483b-91be-cf46ad4f0d7a.acmepaymentscorp",
          "Category" : [ {
            "value" : "user",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      }
    } ]
  },
  "version" : "1.0"

Back to top

Response Headers

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

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

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

Name Description
title The username of the follower.
category An array of roles that the follower has. Each role includes two name/value pairs, value and domain. For example, value might be follower and domain might be uddi:soa.com:relationshiptype, indicating that the user is a follower of the resource.
guid The unique ID for the item; in this case, the following ID.
Action

A set of one or more name/value pairs expressing the action available to the follower. Because following a resource is a yes/no activity, the possible action of a follower will always be to stop following. For example:

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

Note: Actions are returned only if the user requesting the information is authorized to perform the actions.

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.
EntityReferences One or more. For each: Title, GUID, Category

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

More information about Akana API Platform API error messages.

Back to top

Related Topics