GET /api/boards/{BoardID}/board

Returns Board items for the specified user-defined board, in the form of an RSS feed.

Note: There are two operations with essentially the same signature that return the same data in different formats, depending on the Accept header you use. GET /api/boards/{BoardID}/board (this operation) with JSON or XML headers returns an RSS feed, and GET /api/boards/{BoardID}/board with vendor-specific JSON or XML headers returns the information in the form of a JSON or XML object.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned. For more information about how authorization and visibility work for Board operations, see Boards in the Community Manager developer portal.

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for the board items for the Support Board, with no additional parameters.

Sample Request URL

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

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 the board items for the specified board.

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: Fri, 20 Feb 2015 15:38:17 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Board",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Extended Support hours",
      "description" : "We are considering extending Support hours. Comments welcome.",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "support",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "hours",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:published"
      }, {
        "value" : "com.soa.board.item.open",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      }, {
        "value" : "Published",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "discussion11572.acmepaymentscorp"
      },
      "pubDate" : "2015-02-20T20:34:17.000Z",
      "AuthoringUser" : {
        "ID" : "b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp",
        "Name" : "adminacmepaymentscorp",
        "Image" : {
          "Url" : "http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar",
          "Title" : "adminacmepaymentscorp",
          "Link" : "#/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar",
        "Link" : "#/user/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details"
      },
      "CreatedDate" : "2015-02-20T20:17:51.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.unpublish",
          "label" : "discussion.action.unpublish"
        }, {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 1,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "5fe3540c-1e88-4bdb-b170-6d94dc0e327c.acmepaymentscorp",
          "CommentSubjectID" : "discussion11572.acmepaymentscorp",
          "Content" : "Saturday 1-5pm PST would be great for us.",
          "Created" : "2015-02-20T20:34:17Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp",
          "UserName" : "JonathanSwift",
          "AvatarURL" : "http://{hostname}/api/users/2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp/avatar",
          "Published" : false,
          "WorkflowState" : "Pending"
        }, {
          "CommentID" : "3a7e2509-0474-4938-8bcd-2aee1d9ecae1.acmepaymentscorp",
          "CommentSubjectID" : "discussion11572.acmepaymentscorp",
          "Content" : "Awesome! extending to 9pm PST would be great for us since we are in Hawaii.",
          "Created" : "2015-02-20T20:23:24Z",
          "Marks" : 1,
          "IsMarked" : false,
          "UserID" : "434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp",
          "UserName" : "JaneMead",
          "AvatarURL" : "http://{hostname}/api/users/434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp/avatar",
          "Published" : true
        } ]
      },
      "EntityReference" : {
        "Title" : "Support",
        "Guid" : "supportboard.acmepaymentscorp",
        "Category" : [ {
          "value" : "board",
          "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 Board, and the channel includes paging values: StartIndex, TotalResults, and ItemsPerPage. Each item in the RSS channel represents a Board item, and includes the information below.

"value" : "false",
"domain" : "uddi:soa.com:archivable"

"value" : "discussion.action.unpublish",
"label" : "discussion.action.unpublish"

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