assignment2 (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]:

Entity Collection URL: GET /assignment2 (xml) (json) (html)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Create Entity URL: POST /assignment2
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /assignment2/:ID: (xml) (json) (html)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Update Entity URL: PUT /assignment2/:ID:
Response Code Details: 204; 400 if inputs invalid
Delete Entity URL: DELETE /assignment2/:ID:
Response Code Details: 204; 404 if not found

Custom Actions

getFreeAssignmentNameinGradebook : show (GET) : [/assignment2/:ID:/getFreeAssignmentNameinGradebook] (xml) (json) (html)
deleteAssignments : new (POST) : [/assignment2/deleteAssignments]
getMessageBundleText : list (GET) : [/assignment2/getMessageBundleText] (xml) (json) (html)
reorder : list (GET) : [/assignment2/reorder] (xml) (json) (html)
getAssignmentPointsinGradebook : list (GET) : [/assignment2/getAssignmentPointsinGradebook] (xml) (json) (html)
sitelist : list (GET) : [/assignment2/sitelist] (xml) (json) (html)
isPointsGradable : list (GET) : [/assignment2/isPointsGradable] (xml) (json) (html)
isLinkedAssignmentNameInGradebook : show (GET) : [/assignment2/:ID:/isLinkedAssignmentNameInGradebook] (xml) (json) (html)

Entity class : org.sakaiproject.assignment2.model.Assignment2

Type :: bean
Name Type Status
1) acceptUntilDatejava.util.DateRead/Write
2) addRURubricintRead/Write
3) addedToSchedulebooleanRead/Write
4) announcementIdstringRead/Write
5) assignmentAttachmentRefs[Ljava.lang.String;Read/Write
6) assignmentGroupSetjava.util.SetRead/Write
7) attachmentSetjava.util.SetRead/Write
8) contentReviewEnabledbooleanRead/Write
9) contentReviewRefstringRead/Write
10) contextIdstringRead/Write
11) createDatejava.util.DateRead/Write
12) creatorstringRead/Write
13) draftbooleanRead/Write
14) dueDatejava.util.DateRead/Write
15) eventIdstringRead/Write
16) gradebookItemIdlongRead/Write
17) gradebookPointsPossiblestringRead/Write
18) gradebookPointsPossibleDoublejava.lang.DoubleRead Only
19) gradedbooleanRead/Write
20) hasAnnouncementbooleanRead/Write
21) honorPledgebooleanRead/Write
22) idlongRead/Write
23) instructionsstringRead/Write
24) listOfAssociatedGroupReferencesjava.util.ListRead Only
25) modelAnswerAttachmentRefs[Ljava.lang.String;Read/Write
26) modelAnswerAttachmentSetjava.util.SetRead/Write
27) modelAnswerDisplayRuleintRead/Write
28) modelAnswerEnabledbooleanRead/Write
29) modelAnswerTextstringRead/Write
30) modifiedBystringRead/Write
31) modifiedDatejava.util.DateRead/Write
32) numSubmissionsAllowedintRead/Write
33) openbooleanRead Only
34) openDatejava.util.DateRead/Write
35) optimisticVersionintRead/Write
36) propertiesjava.util.MapRead/Write
37) referencestringRead Only
38) removedbooleanRead/Write
39) requiresSubmissionbooleanRead/Write
40) rubricIdlongRead/Write
41) sendSubmissionNotificationsbooleanRead/Write
42) sortIndexintRead/Write
43) submissionOpenbooleanRead Only
44) submissionTypeintRead/Write
45) submissionsSetjava.util.SetRead/Write
46) templateIdstringRead/Write
47) titlestringRead/Write

Data and Request Handling

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

Capabilities

NameTypeDescription
1CoreEntityProviderorg.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
5CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
6Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
7Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
8Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
9Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
10Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
11RESTfulorg.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
12Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
13RequestAwareorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware
14RequestStorableorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable
15Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
16Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
17Saveableorg.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
18Statisticableorg.sakaiproject.entitybroker.entityprovider.capabilities.Statisticable
19Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

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