chat-message (xml)

A chat message represents a message in a chat channel (room).
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 /chat-message (html) (xml) (json) (form)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Create Entity URL: POST /chat-message (form)
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /chat-message/:ID: (html) (xml) (json) (form)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Delete Entity URL: DELETE /chat-message/:ID: (form)
Response Code Details: 204; 404 if not found

Custom Actions

chatData : show (GET) : [/chat-message/:ID:/chatData] (html) (xml) (json) (form)

Entity class : org.sakaiproject.chat2.model.impl.ChatMessageEntityProvider$SimpleChatMessage

Type :: bean
Name Type Status
1) bodystringRead/Write
2) chatChannelIdstringRead/Write
3) contextstringRead/Write
4) idstringRead/Write
5) messageDatejava.util.DateRead/Write
6) messageDateStringorg.sakaiproject.chat2.model.MessageDateStringRead/Write
7) ownerstringRead/Write
8) ownerDisplayIdstringRead/Write
9) ownerDisplayNamestringRead/Write
10) removeablebooleanRead/Write

Data and Request Handling

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

Capabilities

NameTypeDescription
1CoreEntityProviderorg.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
6Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
7Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
8Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
9Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
10Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
11Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
12Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

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