Provides a set of RESTful endpoints for retrieving Sitestats event data.
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
runreport :
list (GET) :
[/sitestats/runreport] (
json)
(GET) Runs the report specified by the id url paramemter. The site id must also be provided in the url.
Example URL: /direct/sitestats/runreport/SITEID.json?id=1
presencetotals :
list (GET) :
[/sitestats/presencetotals] (
json)
(GET) Returns a map of presence total onto user for the specified site id. The site id must be provided in the url.
Example URL: /direct/sitestats/presencetotals/SITEID.json
listreports :
list (GET) :
[/sitestats/listreports] (
json)
(GET) Retrieves a list of predefined reports for a given site id. The id fields in the report entries can be used to run the reports, using the 'run' action
Example URL: /direct/sitestats/listreports/SITEID.json
Data and Request Handling
Output formats : json
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$