Retrieve forums
To retrieve complete information about a forum, use the edit <link> found in the forum entry in the Forums feed.You can use this operation to obtain forum information that you want to preserve prior to performing an update. See Update forums for more information. This method returns the Atom entry of a single forum as opposed to a feed of all the forums.
See Authenticating requests for information about how to authenticate the request.
Table 1. Atom API request details
Method Resource URI Output representation GET forum
- Web address returned in the HTTP location header when the forum was created.
- Web address in the href attribute of the <link> element with the rel="edit" attribute of a forum Atom entry in the Forums feed.
forum
Input
None.
Output
An Atom entry document containing the forum.Returned HTTP headers
HTTP/1.1 200 OK
Indicates that the forum was successfully found and returned. If an error occurs, this header will contain one of the error codes below.
Content-Type: application/atom+xml
Indicates that the document returned contains data in Atom format.
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 404 Not Found
Request:
GET /forums/atom/forum?forumUuid=3b153694-e27e-4085-8868-2952110fdad2 HTTP/1.1 Host: www.dulcinea.com Content-Type: application/atom+xml Authorization: xxxResponse:
HTTP/1.0 200 OK Date: Mon, 11 Jun 2008 18:31:02 GMT Content-Type: application/atom+xml <?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns:snx="http://www.ibm.com/xmlns/prod/sn" xmlns:thr="http://purl.org/syndication/thread/1.0"> <id>urn:lsid:ibm.com:forum:3b153694-e27e-4085-8868-2952110fdad2</id> <title type="text">CKEditor</title> <published>2010-08-04T15:13:29.746Z</published> <updated>2010-08-04T18:06:59.481Z</updated> <author> <email>jdoe@literature.com</email> <name>Jane Doe</name> <snx:userid>F1449510-CF43-D282-8525-7346003DAD9D</snx:userid> <snx:userState>active</snx:userState> </author> <contributor> <email>tsmith@literature.com</email> <name>Tom Smith</name> <snx:userid>4C259C9C-9F1C-85B0-8525-7346003DB02A</snx:userid> <snx:userState>active</snx:userState> </contributor> <link href="http://www.dulcinea.com/forums/atom/entries?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="self" type="application/atom+xml"> </link> <link href="http://www.dulcinea.com/forums/atom/forum?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="edit" type="application/atom+xml"> </link> <category term="forum-forum" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category> <category term="ckeditor"></category> <link href="http://www.dulcinea.com/forums/html/forum?id=3b153694-e27e-4085-8868-2952110fdad2" rel="alternate" type="text/html"> </link> <link href="http://www.dulcinea.com/forums/atom/topics?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="replies" type="application/atom+xml" thr:count="0"> </link> <link href="http://www.dulcinea.com/forums/atom/service?forumUuid=3b153694-e27e-4085-8868-2952110fdad2" rel="service" type="application/atomsvc+xml" title="Atom Publishing Protocol"> </link> <thr:in-reply-to href="http://www.dulcinea.com/forums/atom/forums" ref="http://www.dulcinea.com/forums/atom/forums" type="application/atom+xml"> </thr:in-reply-to> <content type="html">Read a great short story yesterday.</content> </entry>
Parent topic
Work with stand-alone forums
});