commons (xml)


Provides a set of RESTful endpoints for retrieving COMMONS posts.

RESTful URLs: http://microformats.org/wiki/rest/urls
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

deletePost : list (GET) : [/commons/deletePost] (json) (xml)
deleteComment : list (GET) : [/commons/deleteComment] (json) (xml)
savePost : new (POST) : [/commons/savePost]
doesLike : list (GET) : [/commons/doesLike] (json) (xml)
getUrlMarkup : list (GET) : [/commons/getUrlMarkup] (json) (xml)
posts : list (GET) : [/commons/posts] (json) (xml)
(GET) Retrieves a summary of posts for a given site id, as specified in the path. The posts are minimised, in that the content and comments are removed before being returned.
Example URL: /direct/commons/posts/SITEID.json
likePost : new (POST) : [/commons/likePost]
postLikes : list (GET) : [/commons/postLikes] (json) (xml)
countLikes : list (GET) : [/commons/countLikes] (json) (xml)
saveComment : new (POST) : [/commons/saveComment]
post : list (GET) : [/commons/post] (json) (xml)
savePermissions : new (POST) : [/commons/savePermissions]
userPerms : list (GET) : [/commons/userPerms] (json) (xml)
perms : list (GET) : [/commons/perms] (json) (xml)
uploadImage : new (POST) : [/commons/uploadImage]
userLikes : list (GET) : [/commons/userLikes] (json) (xml)

Data and Request Handling

Output formats : json, xml
Input formats : No formats allowed
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
4Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
5Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
6ReferenceParseableorg.sakaiproject.entitybroker.entityprovider.capabilities.ReferenceParseable
7RequestAwareorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware

REST:: 1.0.1 SVN: $Revision$ : $Date$