GET /api/users/{UserID}/board

Returns a list of Board items for the specified user.

Authorization Roles/Permissions: Must be logged in. Self (logged in) or Site Admin (for any user).

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/users/{UserID}/board

Sample Request

Request URL #1

Returns only group member requests.

https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/board?ItemType=GroupMemberReq

Request URL #2

Returns only the Board item that matches the specified ItemID.

https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/board?ItemID=group_member_req11039.acmepaymentscorp

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 requested Board items for the specified user. The information is sent as an RSS channel in JSON or XML format.

Sample Response

The sample response below shows Board items that match the parameters specified in Request URL #2. Only the Board item that matches the specified ItemID is returned.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 21 May 2013 00:28:30 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "User Board",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Membership cancellation",
      "description" : "Membership is cancelled",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      } ],
      "guid" : {
        "value" : "group_member_req11039.acmepaymentscorp"
      },
      "pubDate" : "2012-05-25T04:07:56.000Z",
      "AuthoringUser" : {
        "ID" : "6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp",
        "Name" : "melgm",
        "Image" : {
          "Url" : "https://{hostname}/api/users/6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp/avatar",
          "Title" : "melgm",
          "Link" : "#/users/6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp/avatar",
        "Link" : "#/user/6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp/details"
      },
      "CreatedDate" : "2012-05-25T04:07:56.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "comment11040.acmepaymentscorp",
          "CommentSubjectID" : "group_member_req11039.acmepaymentscorp",
          "Content" : "melgm cancelled the membership request",
          "Created" : "2012-05-25T04:07:56Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp",
          "UserName" : "melgm",
          "AvatarURL" : "https://{hostname}/api/users/6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.acmepaymentscorp/avatar"
        } ]
      },
      "EntityReference" : {
        "Title" : "melgm",
        "Guid" : "6824eb45-a84f-44a8-9fb4-5a0a0410dd2c.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 User 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"

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