GET /api/boards/{BoardID}

Returns information about a user-defined board or the Support Board.

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 developer portal.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

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

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

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/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

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 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 11:02:59 GMT

Sample response body: application/json

{
  "BoardID" : "supportboard.acmepaymentscorp",
  "BoardType" : "board",
  "Title" : "Support",
  "Visibility" : "Public",
  "IsFollowed" : false,
  "State" : "com.soa.api.state.active",
  "AvatarURL" : "http://acmepaymentscorp/api/boards/supportboard.acmepaymentscorp/avatar"
}

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Board xmlns="http://soa.com/xsd/board/1.0" xmlns:ns2="http://soa.com/xsd/comment/1.0" 
xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns5="http://soa.com/xsd/resource/1.0" xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns7="http://soa.com/xsd/review/1.0" xmlns:ns8="http://soa.com/xsd/ticket/1.0" 
xmlns:ns9="http://soa.com/xsd/api/1.0" xmlns:ns10="http://soa.com/xsd/app/1.0" 
xmlns:ns11="http://soa.com/xsd/discussion/1.0" xmlns:ns12="http://soa.com/xsd/alert/1.0" 
xmlns:ns13="http://soa.com/xsd/contract/1.0">
  <BoardID>supportboard.acmepaymentscorp</BoardID>
  <BoardType>board</BoardType>
  <Title>Support</Title>
  <Visibility>Public</Visibility>
  <IsFollowed>false</IsFollowed>
  <State>com.soa.api.state.active</State>
  <AvatarURL>http://acmepaymentscorp/api/boards/supportboard.acmepaymentscorp/avatar</AvatarURL>
</Board>

Back to top

Response Headers

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

Header Description
Content-Type

application/json, application/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

Name Type Description
Board Board

Contains information about a Forum (Board) on the platform.

In this scenario, it is always a user-defined board.

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