gradebook (xml)

Represent Gradebook items and also special provider that instead delegates to the Gradebook tool views
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]:

Show Entity URL: GET /gradebook/:ID: (xml) (json)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Custom Actions

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}
site : list (GET) : [/gradebook/site] (xml) (json)
Retrieve the Gradebook items for a site. The request url pattern: /direct/gradebook/site/{siteId}.{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) commentstringRead/Write
2) dateRecordedjava.util.DateRead/Write
3) gradestringRead/Write
4) graderUserIdstringRead/Write
5) itemNamestringRead/Write
6) pointsjava.lang.DoubleRead/Write
7) userIdstringRead/Write
8) userNamestringRead/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

NameTypeDescription
1CoreEntityProviderorg.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
6Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
7Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

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