Navigate Communities resources 

Describes how to navigate from one Communities resource to another using the resources made available through the API.

When you create an application that accesses Communities resources, do not construct URLs to Communities resources; instead write code to follow the links from the user's service document to the user's my communities or all communities collections, and then to each individual community.

The following diagram illustrates how to navigate from the service document to all the available Communities resources.


Identifies the order in which to access the resources.
The following table describes the available Communities resources.
Table 1. Communities resources

Resource URI Method | Representation Description
All communities Value of the href attribute of the <collection> element that contains a <title> element which has a value of All Communities in the Communities Collections workspace in the service document. GET | community list feed Collection of all communities.
Bookmark Found in the href attribute of the <link> element that has a rel="edit" attribute value for each entry in the bookmarks feed.

  • GET | bookmark entry

  • PUT | bookmark entry

  • DELETE

Represents a bookmark.
Bookmarks Found in the href attribute of the <link> element that has a rel="http://www.ibm.com/xmlns/prod/sn/bookmarks" attribute value for each community.

  • GET | bookmarks feed

  • POST | bookmark entry

Collection of bookmarks.
Community Found in the href attribute of the <link> element that has a rel="edit" attribute value for each entry in the my communities feed.

  • GET | community entry

  • PUT | community entry

  • DELETE

Represents a community.
Feed link Found in the href attribute of the <link> element that has a rel="edit" attribute value for each entry in the feed links feed.

  • GET | feed link entry

  • PUT | feed link entry

  • DELETE

Represents a feed link.
Feed links Found in the href attribute of the <link> element that has a rel="http://www.ibm.com/xmlns/prod/sn/feeds" attribute value for each community.

Collection of feed links.
Forum replies Found in the href attribute of the <link> element with the rel="replies" attribute value in the forum topics feed.

  • GET | forum replies feed

  • POST | forum reply entry


Forum reply Found in the href attribute of the <link> element that has a rel="edit" attribute value for each entry in the forum replies feed.

  • GET | forum reply entry

  • PUT | forum reply entry

  • DELETE


Forum topic Found in the href attribute of the <link> element that has a rel="edit" attribute value for each entry in the forum topics feed.

  • GET | forum topic entry

  • POST | forum topic entry

  • DELETE


Forum topics Found in the href attribute of the <link> element with the rel="http://www.ibm.com/xmlns/prod/sn/forum-topics" attribute value for each community.


My communities Found in the href attribute of the <collection> element that contains a <title> element which has a value of My Communities in the Communities Collections workspace.

  • GET | community list feed

  • POST | community entry

Collection of communities belonging to a specified person.
Service document atom/service GET | Service Document As defined in the Atompub specification. Access a user's service document to retrieve the communities collections workspace.


Parent topic

Communities API


   

 

File TypeSizeFile NameCreated On
image/gif 14 KB comm_nav.gif 4/6/11 6:22 PM

});