grades (xml)

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 /grades/:ID: (xml) (json)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Custom Actions

courses : list (GET) : [/grades/courses] (xml) (json)
students : list (GET) : [/grades/students] (xml) (json)
gradeitem : * : [/grades/gradeitem] (xml) (json)
gradebook : list (GET) : [/grades/gradebook] (xml) (json)

Entity class : org.sakaiproject.gradebook.entity.Gradebook

Type :: bean
Name Type Status
1) averageCourseGradestringRead/Write
2) categoryjava.util.ListRead/Write
3) courseIdstringRead/Write
4) displayReleasedGradeItemsToStudentsbooleanRead/Write
5) gradebookScalestringRead/Write
6) idstringRead/Write
7) isLetterGradeFlagbooleanRead/Write
8) isPercentFlagbooleanRead/Write
9) isPointFlagbooleanRead/Write
10) itemsjava.util.ListRead/Write
11) studentsjava.util.ListRead/Write

Data and Request Handling

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

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
4Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
5Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
6Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
7RequestAwareorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware
8Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
9Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

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