Provides a set of RESTful endpoints for retrieving single fora, site collections of fora , individual topics (collections of conversations) and messages with their children. An example workflow would be to call the site action with /direct/forums/site/SITEID.json for the top level fora in a site, then to use /direct/forums/site/SITEID/forum/FORUMID.json to get an individual forum to the topic level. After that you would use /direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID.json to get a topic, basicallya set of conversations, then you would call /direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID/message/MESSAGEID.json to get a fully populated message with attachments and children.
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)
Custom Actions
site :
list (GET) :
[/forums/site] (
json) (
xml)
(GET) Retrieves fora, topics and conversations for a given site id.
Get all fora for a site:
/direct/forums/site/SITEID.json
Get all topics for a forum:
/direct/forums/site/SITEID/forum/FORUMID.json
Get all conversations for a topic:
/direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID.json
Get a fully populated conversation or message. This retrieves the message tree from the specified message downwards. If the MESSAGEID is the top level message in a conversation, the entire conversation is returned.
/direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID/message/MESSAGEID.json
Data and Request Handling
Output formats : json, xml
Input formats : No formats allowed
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
|---|
| 1 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
| 2 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
| 3 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
| 4 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 5 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$