GET /api/users/{UserID}/feeds/homefeed

Returns the user's feed from the user's home system.

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

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/users/{UserID}/feeds/homefeed[?APIID=APIID][&ItemType=ItemType][&TicketLabel=TicketLabel]
[&TicketState=TicketState][&ItemID=ItemID][&Tag=Tag][&IncludeComments=IncludeComments]
[&NumberOfComments=NumberOfComments][&IncludeActions=IncludeActions][&count=count][&SortBy=SortBy]

Back to top

Sample Request

Request URL #1

The example below requests the first 10 items for the specified user.

https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/feeds/homefeed?start=0&count=10&RetrievingUserID=522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp

Request URL #2

The example below requests the third and fourth items, with comments excluded.

https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/feeds/homefeed?start=2&count=2&RetrievingUserID=522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp&IncludeComments=false

Sample request headers

GET /api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/feeds/homefeed?start=0&count=10&RetrievingUserID=2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp&SortBy=DescendingDate HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_{tenant}: {TokenID}

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user.
AppID Query string Optional If specified, only board items relating to that app are returned. If not specified, items relating to all apps are returned.
APIID Query string Required The unique ID for a specific API.
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 a list of valid values, see Board Item (forum entry) Types.
DiscussionType Query string Optional The type of discussion. No longer in use.
TicketLabel Query string Optional A filtering parameter: if specified, only tickets with that label are returned. If not specified, no filter is applied. For valid values, refer to Ticket Label Values.
TicketState Query string Optional A filtering parameter: if specified, only tickets of that state are returned. For valid values, refer to Ticket State Values.
ItemID Query string Optional

The unique ID for a specific forum entry.

If specified, results are limited to items 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 resources 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.
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 home feed for the specified user. The information is sent as an RSS channel in JSON or XML format.

Back to top

Sample Response

The sample response below shows the results from request query #2 above—the third and fourth home feed items without comments.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 30 May 2013 20:11:25 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "User Feed",
    "startIndex" : 2,
    "itemsPerPage" : 2,
    "item" : [ {
      "title" : "ACMECorp member JonathanSwift  has been invited to the PaaStime application team",
      "description" : "ACMECorp member JonathanSwift, I would like to invite you to join the development team for my application.",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      } ],
      "guid" : {
        "value" : "group_member_req17574.acmepaymentscorp"
      },
      "pubDate" : "2013-05-30T00:10:01.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.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/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2012-11-26T15:20:30.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 3
      },
      "EntityReference" : [ {
        "Title" : "JonathanSwift",
        "Guid" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    }, {
      "title" : "API Access request",
      "description" : "ACMECorp member JaneSaoirse has requested access to the Sandbox implementation for the ACME Payments DeLuxe (Version 2.0) 
on behalf of the  PaaStime (2.0) application",
      "category" : [ {
        "value" : "CONTRACT_REQUEST",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "apicontract.status.activated",
        "domain" : "uddi:soa.com:wfstate"
      }, {
        "value" : "Sandbox",
        "domain" : "uddi:soa.com:environment"
      } ],
      "guid" : {
        "value" : "contract_request23623.acmepaymentscorp"
      },
      "pubDate" : "2013-05-23T22:14:30.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/apps/app16964.acmepaymentscorp/avatars/f250a96e-2f81-4e3e-88fc-61431fd80e5c.png",
        "Link" : "#/app/app16964.acmepaymentscorp"
      },
      "CreatedDate" : "2013-05-23T22:14:30.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "apicontract.action.suspend",
          "label" : "apicontract.action.suspend"
        }, {
          "value" : "apicontract.action.cancel",
          "label" : "apicontract.action.cancel"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Guid" : "contract23622.acmepaymentscorp",
          "Category" : [ {
            "value" : "contract",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      },
      "EntityReference" : [ {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "ACME Payments DeLuxe",
        "Guid" : "api19427.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "ACME Payments DeLuxe",
        "Guid" : "api19427.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "Version 2.0",
        "Guid" : "apiversion19429.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: text/xml

Accept: text/xml

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>User Feed</title>
    <ns6:startIndex>2</ns6:startIndex>
    <ns6:itemsPerPage>2</ns6:itemsPerPage>
    <item>
      <title>ACMECorp member JonathanSwift  has been invited to the PaaStime application team</title>
      <description>ACMECorp member JonathanSwift, I would like to invite you to join the development team for my application.</description>
      <category domain="uddi:soa.com:resourcetype">GROUP_MEMBER_REQ</category>
      <category domain="uddi:soa.com:archivable">true</category>
      <guid>group_member_req17574.acmepaymentscorp</guid>
      <pubDate>2013-05-30T00:10:01.000Z</pubDate>
      <ns4:CreatedDate>2012-11-26T15:20:30.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>3</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/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>JonathanSwift</Title>
        <Guid>957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">user</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns4:Image>
    </item>
    <item>
      <title>API Access request</title>
      <description>ACMECorp member JaneSaoirse has requested access to the Sandbox implementation for the ACME Payments DeLuxe (Version 2.0) 
on behalf of the  PaaStime (2.0) application</description>
      <category domain="uddi:soa.com:resourcetype">CONTRACT_REQUEST</category>
      <category domain="uddi:soa.com:archivable">false</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.activated</category>
      <category domain="uddi:soa.com:environment">Sandbox</category>
      <guid>contract_request23623.acmepaymentscorp</guid>
      <pubDate>2013-05-23T22:14:30.000Z</pubDate>
      <ns4:CreatedDate>2013-05-23T22:14:30.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>1</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/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>2.0</Title>
        <Guid>4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>ACME Payments DeLuxe</Title>
        <Guid>api19427.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>ACME Payments DeLuxe</Title>
        <Guid>api19427.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>Version 2.0</Title>
        <Guid>apiversion19429.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/apps/app16964.acmepaymentscorp/avatars/f250a96e-2f81-4e3e-88fc-61431fd80e5c.png</Url>
        <Link>#/app/app16964.acmepaymentscorp</Link>
      </ns4:Image>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Guid>contract23622.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">contract</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Actions>
        <ns4:Action label="apicontract.action.suspend">apicontract.action.suspend</ns4:Action>
        <ns4:Action label="apicontract.action.cancel">apicontract.action.cancel</ns4:Action>
      </ns4:Actions>
    </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 User Feed, and the channel includes paging values: StartIndex and ItemsPerPage. Each item in the RSS channel represents a home feed entry, and includes the information below.

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

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

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

The example above indicates a group membership request.

GUID GUID for the feed item.
pubdate The date/timestamp when the information was generated.
Entity reference

An array of one or more entity references for the feed 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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics