mailarchive (xml)

Represents mailarchive messages for a given site
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

siteMessages : list (GET) : [/mailarchive/siteMessages] (xml) (json)
Retrieve Email Archive messages for a site. /siteMessages/{siteId}
channelMessages : list (GET) : [/mailarchive/channelMessages] (xml) (json)
Retrieve messages in a MailArchiveChannel. /channelMessages/{siteId}/{channelId}
siteChannels : list (GET) : [/mailarchive/siteChannels] (xml) (json)
Retrieve MailArchiveChannel entities within giving site. /siteChannels/{siteId}
message : list (GET) : [/mailarchive/message] (xml) (json)
Retrieve an Email Archive message based on the path used by the EmailArchive service internally. /message/{siteId}/{emailArchiveChannelId}/{emailArchiveMessageId}

Entity class : org.sakaiproject.mailarchive.entityprovider.MailArchiveEntityProvider$DecoratedMailArchiveMessage

Type :: bean
Name Type Status
1) attachmentsjava.util.ListRead/Write
2) bodystringRead/Write
3) channelstringRead/Write
4) createdByDisplayNamestringRead/Write
5) createdOnjava.util.DateRead/Write
6) headersjava.util.ListRead/Write
7) idstringRead Only
8) mailArchiveMessageIdstringRead/Write
9) siteIdstringRead/Write
10) siteTitlestringRead/Write
11) subjectstringRead/Write

Data and Request Handling

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



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