Handles the i>clicker registration and integrate data feeds for the Sakai system, all operations are for the current user so authentication is required for all operations, the base item handled by this provider is a i>clicker registration but feeds are also available for gradebook, course, and student 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)
Sample Entity URLs (_id=':ID:') [may not be valid]:
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Retrieves the list of all i>clicker registrations for the current user
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Adds an i>clicker registration, will always set the owner/created by to the current user, only the clickerId field is required when creating a registration: POST /iclicker/
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Allows checking for and viewing of data from a single i>clicker registration by internalId (numeric) or clickerId
Custom Actions
courses :
list (GET) :
[/iclicker/courses] (
xml) (
json)
Retrieves a listing of all courses for the current user by default, can optionally get a single course and student using: GET /iclicker/courses/
activate :
edit (PUT) :
[/iclicker/:ID:/activate]
Activate/enable an i>clicker registration: POST /iclicker/activate/
students :
list (GET) :
[/iclicker/students] (
xml) (
json)
Retrieves a listing of all students in a course with i>clicker registrations indicated: GET /iclicker/students/
gradebook :
list (GET) :
[/iclicker/gradebook] (
xml) (
json)
Retrieves a listing of all gradebook data in a course: GET /iclicker/gradebook/
validate :
new (POST) :
[/iclicker/validate]
Validate an i>clicker registration: POST /iclicker/activate/
deactivate :
edit (PUT) :
[/iclicker/:ID:/deactivate]
Deactivate/disable an i>clicker registration: POST /iclicker/activate/
Entity class : org.sakaiproject.iclicker.model.ClickerRegistration
Type :: bean
|
Name |
Type |
Status |
| 1) | activated | boolean | Read/Write |
| 2) | clickerId | string | Read/Write |
| 3) | dateCreated | java.util.Date | Read/Write |
| 4) | dateModified | java.util.Date | Read/Write |
| 5) | id | long | Read/Write |
| 6) | key | string | Read Only |
| 7) | locationId | string | Read/Write |
| 8) | national | boolean | Read/Write |
| 9) | ownerId | string | Read/Write |
| 10) | userDisplayName | string | Read/Write |
Data and Request Handling
Output formats : xml, json
Input formats : html, xml, json
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 | CollectionResolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable | |
| 4 | Createable | org.sakaiproject.entitybroker.entityprovider.capabilities.Createable | |
| 5 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 6 | Inputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable | |
| 7 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 8 | Redirectable | org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable | |
| 9 | RequestAware | org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware | |
| 10 | Resolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable | |
| 11 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$