forum_message (xml)

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)

Sample Entity URLs (_id=':ID:') [may not be valid]:

Entity Collection URL: GET /forum_message
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Create Entity URL: POST /forum_message
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /forum_message/:ID:
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Update Entity URL: PUT /forum_message/:ID:
Response Code Details: 204; 400 if inputs invalid
Delete Entity URL: DELETE /forum_message/:ID:
Response Code Details: 204; 404 if not found

Custom Actions

private : list (GET) : [/forum_message/private]
topic : list (GET) : [/forum_message/topic]
markread : new (POST) : [/forum_message/markread]

Entity class : org.sakaiproject.component.app.messageforums.entity.ForumMessageEntityProviderImpl$DecoratedMessage

Type :: bean
Name Type Status
1) attachmentsjava.util.ListRead/Write
2) authoredBystringRead/Write
3) bodystringRead/Write
4) createdOnstringRead/Write
5) indentIndexintRead/Write
6) labelstringRead/Write
7) lastModifiedstringRead/Write
8) messageIdlongRead/Write
9) profileImageURLstringRead/Write
10) readbooleanRead/Write
11) recipientsstringRead/Write
12) repliesjava.util.ListRead/Write
13) replyTolongRead/Write
14) titlestringRead/Write
15) topicIdlongRead/Write

Data and Request Handling

Output formats : No formats allowed
Input formats : No formats allowed
Access Provider available for request processing : HttpServletAccessProvider

Capabilities

NameTypeDescription
1ForumMessageEntityProviderorg.sakaiproject.api.app.messageforums.entity.ForumMessageEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
6CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
7Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
8Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
9Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
10Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
11Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
12PropertyProvideableorg.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable
13Propertyableorg.sakaiproject.entitybroker.entityprovider.capabilities.Propertyable
14RESTfulorg.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
15Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
16RequestAwareorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware
17RequestStorableorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable
18Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
19Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
20Saveableorg.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
21Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

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