GET /api/groups/{GroupID}/board

Returns a list of Board items for the specified group.

Authorization Roles/Permissions: For a public group or a group associated with a public API, anyone can access this operation. For an API Scope Group, only authorized 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

Back to top

URL

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

Back to top

Sample Request

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

Request URL

https://{hostname}/api/groups/group19793.acmepaymentscorp/board

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

Content-Type */*
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
GroupID Path string Required The unique ID for a specific group.
ItemType Query string[ ] Optional A filtering parameter, specifying one or more board item (forum entry) types to be returned, such as an alert, discussion, or ticket. For valid values, see Board Item Types.
DiscussionType Query string Optional The type of discussion. No longer in use.
ItemID Query string Optional

The unique ID for a specific forum entry.

If specified, results are limited to information relating to that item ID. If not specified, no filter is applied.

Tag Query string Optional

A user-defined tag.

If specified, results are limited to board items relating to that tag. If not specified, no filter is applied.

IncludeComments Query boolean Optional Indicates whether comments should be included in the information returned. Default: true. If set to false, comments are excluded.
NumberOfComments Query integer Optional The number of comments to be returned (if IncludeComments is not set to false). Default value: 2.
IncludeActions Query boolean Optional Indicates whether workflow actions currently valid for the resource should be included in the results. Default: true. For valid workflow actions, see Workflow Actions.
start Query integer Optional An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
count Query integer Optional The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.
SortBy Query string Optional An optional parameter allowing users to sort results by a specific value; for example, com.soa.sort.order.updated sorts with the most updated entries first. For valid values, see Sort By Values. If not specified, items are returned in the sort order of DescendingDate, which means that the most recent items are first.
RetrievingUserID Query string Optional The unique UserID of the user performing a specific action.
IncludeSelfAuthored Query string Optional

Indicates whether resources authored by the requestor should be included.

Default: true.

PublishedState Query string Optional

Indicates that only resources in a specific state should be returned. Valid values: published or unpublished.

Default: published, indicating that only resources that have been published are returned.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the Group Board for the specified group.

Back to top

Sample Response

The sample response below shows the group's Board returned.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 12 Jun 2013 20:00:01 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Group Board",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Planned outage",
      "description" : "The API will be down for a maximum of one hour, 6am to 7am PT (GMT-7) on Sunday 16 June for equipment upgrade.",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "outage",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "upgrade",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.board.item.acmepaymentscorp",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      } ],
      "guid" : {
        "value" : "discussion24508.acmepaymentscorp"
      },
      "pubDate" : "2013-06-12T19:59:54.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-06-12T19:59:54.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : {
        "Title" : "ACME Payments API UG",
        "Guid" : "group19212.acmepaymentscorp",
        "Category" : [ {
          "value" : "group",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    }, {
      "title" : "Features list: suggestions?",
      "description" : "We are getting together our features list for the next version. Any suggestions welcome!",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "version",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "features",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "payments",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "improve",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.board.item.acmepaymentscorp",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      } ],
      "guid" : {
        "value" : "discussion24489.acmepaymentscorp"
      },
      "pubDate" : "2013-06-12T19:57:21.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-06-12T19:53:24.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 4,
        "Comment" : [ {
          "CommentID" : "comment24506.acmepaymentscorp",
          "CommentSubjectID" : "discussion24489.acmepaymentscorp",
          "Content" : "International currency support is the feature that would help me the most.",
          "Created" : "2013-06-12T19:57:11Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
          "UserName" : "JonathanSwift",
          "AvatarURL" : "https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png"
        }, {
          "CommentID" : "comment24507.acmepaymentscorp",
          "CommentSubjectID" : "discussion24489.acmepaymentscorp",
          "Content" : "Also, seconding both of Philip's comments. Gift cards would be awesome.",
          "Created" : "2013-06-12T19:57:21Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
          "UserName" : "JonathanSwift",
          "AvatarURL" : "https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png"
        } ]
      },
      "EntityReference" : {
        "Title" : "ACME Payments API UG",
        "Guid" : "group19212.acmepaymentscorp",
        "Category" : [ {
          "value" : "group",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    }, {
      "title" : "ACMECorp member JenniferMeadows  has been invited to the ACME Payments API UG Group",
      "description" : "Please join our user group!",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.group.membership.state.pending",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "group_member_req24505.acmepaymentscorp"
      },
      "pubDate" : "2013-06-12T19:53:45.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-06-12T19:53:45.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "acmepaymentscorp",
        "Guid" : "api18969.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "apiversion19184.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "ACME Payments API UG",
        "Guid" : "group19212.acmepaymentscorp",
        "Category" : [ {
          "value" : "group",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "JenniferMeadows",
        "Guid" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: text/xml

Status Code: 200 OK
Content-Type: text/xml
Date: Wed, 12 Jun 2013 20:04:22 GMT

Sample response body: text/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/rss/1.0" 
xmlns:ns5="http://soa.com/xsd/comment/1.0" xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns7="http://soa.com/xsd/resource/1.0" 
xmlns:ns8="http://soa.com/xsd/fault/1.0" xmlns:ns9="http://soa.com/xsd/api/1.0" xmlns:ns10="http://soa.com/xsd/board/1.0" version="1.0">
  <channel>
    <title>Group Board</title>
    <ns6:startIndex>0</ns6:startIndex>
    <ns6:itemsPerPage>0</ns6:itemsPerPage>
    <item>
      <title>Planned outage</title>
      <description>The API will be down for a maximum of one hour, 6am to 7am PT (GMT-7) on Sunday 16 June for equipment upgrade.</description>
      <category domain="uddi:soa.com:resourcetype">DISCUSSION</category>
      <category domain="uddi:soa.com:tag">outage</category>
      <category domain="uddi:soa.com:tag">upgrade</category>
      <category domain="uddi:soa.com:archivable">true</category>
      <category domain="uddi:soa.com:state">com.soa.board.item.acmepaymentscorp</category>
      <category domain="uddi:soa.com:discussiontype">com.soa.discussion.type.comment</category>
      <guid>discussion24508.acmepaymentscorp</guid>
      <pubDate>2013-06-12T19:59:54.000Z</pubDate>
      <ns4:CreatedDate>2013-06-12T19:59:54.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>0</ns5:Count>
      </ns5:CommentsPreview>
      <ns4:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns4:Image>
          <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>ACME Payments API UG</Title>
        <Guid>group19212.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">group</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Actions>
        <ns4:Action label="discussion.action.delete">discussion.action.delete</ns4:Action>
      </ns4:Actions>
    </item>
    <item>
      <title>Features list: suggestions?</title>
      <description>We are getting together our features list for the next version. Any suggestions welcome!</description>
      <category domain="uddi:soa.com:resourcetype">DISCUSSION</category>
      <category domain="uddi:soa.com:tag">version</category>
      <category domain="uddi:soa.com:tag">features</category>
      <category domain="uddi:soa.com:tag">payments</category>
      <category domain="uddi:soa.com:tag">improve</category>
      <category domain="uddi:soa.com:archivable">true</category>
      <category domain="uddi:soa.com:state">com.soa.board.item.acmepaymentscorp</category>
      <category domain="uddi:soa.com:discussiontype">com.soa.discussion.type.comment</category>
      <guid>discussion24489.acmepaymentscorp</guid>
      <pubDate>2013-06-12T19:57:21.000Z</pubDate>
      <ns4:CreatedDate>2013-06-12T19:53:24.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>4</ns5:Count>
        <ns5:Comment>
          <ns5:CommentID>comment24506.acmepaymentscorp</ns5:CommentID>
          <ns5:CommentSubjectID>discussion24489.acmepaymentscorp</ns5:CommentSubjectID>
          <ns5:Content>International currency support is the feature that would help me the most.</ns5:Content>
          <ns5:Created>2013-06-12T19:57:11Z</ns5:Created>
          <ns5:Marks>0</ns5:Marks>
          <ns5:IsMarked>false</ns5:IsMarked>
          <ns3:UserID>957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp</ns3:UserID>
          <ns3:UserName>JonathanSwift</ns3:UserName>
          <ns3:AvatarURL>https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png</ns3:AvatarURL>
        </ns5:Comment>
        <ns5:Comment>
          <ns5:CommentID>comment24507.acmepaymentscorp</ns5:CommentID>
          <ns5:CommentSubjectID>discussion24489.acmepaymentscorp</ns5:CommentSubjectID>
          <ns5:Content>Also, seconding both of Philip's comments. Gift cards would be awesome.</ns5:Content>
          <ns5:Created>2013-06-12T19:57:21Z</ns5:Created>
          <ns5:Marks>0</ns5:Marks>
          <ns5:IsMarked>false</ns5:IsMarked>
          <ns3:UserID>957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp</ns3:UserID>
          <ns3:UserName>JonathanSwift</ns3:UserName>
          <ns3:AvatarURL>https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png</ns3:AvatarURL>
        </ns5:Comment>
      </ns5:CommentsPreview>
      <ns4:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns4:Image>
          <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>ACME Payments API UG</Title>
        <Guid>group19212.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">group</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Actions>
        <ns4:Action label="discussion.action.delete">discussion.action.delete</ns4:Action>
      </ns4:Actions>
    </item>
    <item>
      <title>ACMECorp member JenniferMeadows  has been invited to the ACME Payments API UG Group</title>
      <description>Please join our user group!</description>
      <category domain="uddi:soa.com:resourcetype">GROUP_MEMBER_REQ</category>
      <category domain="uddi:soa.com:archivable">false</category>
      <category domain="uddi:soa.com:wfstate">com.soa.group.membership.state.pending</category>
      <guid>group_member_req24505.acmepaymentscorp</guid>
      <pubDate>2013-06-12T19:53:45.000Z</pubDate>
      <ns4:CreatedDate>2013-06-12T19:53:45.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>0</ns5:Count>
      </ns5:CommentsPreview>
      <ns4:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns4:Image>
          <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>acmepaymentscorp</Title>
        <Guid>api18969.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>2.0</Title>
        <Guid>apiversion19184.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>ACME Payments API UG</Title>
        <Guid>group19212.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">group</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>JenniferMeadows</Title>
        <Guid>d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">user</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/63352786-b8f0-4717-a35e-cebb480c5a56.png</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns4:Image>
    </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 Group Board, and the channel includes paging values: StartIndex and ItemsPerPage. Each item in the RSS channel represents a Board item, and includes the information below.

Name Description
title The text title of the Board item.
description Descriptive text for the Board item.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example:

"value" : "DISCUSSION",
"domain" : "uddi:soa.com:resourcetype"

The example above indicates that the Board item relates to a discussion.

"value" : "outage",
"domain" : "uddi:soa.com:tag"

The example above indicates that the Board item relates to a tag on the discussion.

GUID GUID for the Board item. It is the unique DiscussionID; for example, discussion24508.acmepaymentscorp.
pubdate The date/timestamp when the information was generated.
AuthoringUser

Information about the user who authored the Board item, including:

  • ID: the unique UserID
  • Name: The user's name as it appears in the platform
  • Image: Information about the user's image, including URL, Title, and Link
Image Information about the image for the user that the Board item is associated with, including URL and link.
CreatedDate The date/timestamp when the information was generated.
Actions

An array of name/value pair sets containing information about one or more action events that are valid for the item. Each includes value and label, and both contain the name of the valid action. For example:

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

The example above indicates that Delete is a valid action for the Board item.

Marks Information about marks on the Board item, including a numeric count and a boolean value, IsMarkedByReader, indicating whether the current user (if a user is logged in) marked the Board item.
CommentsPreview

Information about comments on the Board item, including a numeric count and information about the specific comments, if applicable.

If present, information about a specific comment includes: CommentID, CommentSubjectID, Content, Created (date), Marked, IsMarked, UserID, UserName, and AvatarURL.

EntityReference

An array of one or more entity references for the Board item. Each includes:

  • Title
  • GUID: the unique ID for the item.
  • Category[ ]: An array of sets of two name/value pairs, each including Value and Domain, with a value for each.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics