Represent Gradebook items and also special provider that instead delegates to the Gradebook tool views
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
Custom Actions
site :
list (GET) :
[/gradebook/site] (
xml) (
json)
Retrieve the Gradebook items for a site. The request url pattern: /direct/gradebook/site/{siteId}.{format}
item :
list (GET) :
[/gradebook/item] (
xml) (
json)
Retrieve details of an assignment grading specified by the assignment name. The request url pattern: /direct/gradebook/item/{siteId}/{assignmentName}.{format}
my :
list (GET) :
[/gradebook/my] (
xml) (
json)
Retrieve all my grades for all of my sites. The request url pattern: /direct/gradebook/my.{format}
Entity class : org.sakaiproject.tool.gradebook.ui.helpers.entity.GradeAssignmentItemDetail
Type :: bean
|
Name |
Type |
Status |
| 1) | comment | string | Read/Write |
| 2) | dateRecorded | java.util.Date | Read/Write |
| 3) | grade | string | Read/Write |
| 4) | graderUserId | string | Read/Write |
| 5) | itemName | string | Read/Write |
| 6) | points | java.lang.Double | Read/Write |
| 7) | userId | string | Read/Write |
| 8) | userName | string | Read/Write |
Data and Request Handling
Output formats : xml, json
Input formats : No formats allowed
Access Provider available for request processing : EntityViewAccessProvider
Access Provider available for request processing : EntityViewAccessProvider
Capabilities
| Name | Type | Description |
|---|
| 1 | CoreEntityProvider | org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider | |
| 2 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
| 3 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
| 4 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
| 5 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 6 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 7 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$