assignment (xml)

Represents assignments for a given site.
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 /assignment/:ID: (xml) (json) (form)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Custom Actions

deepLinkWithPermissions : list (GET) : [/assignment/deepLinkWithPermissions] (xml) (json) (form)
The action takes assignment reference, and boolean value for allowReadAssignment, allowAddAssignment, allowSubmitAssignment and returns the deepLink url. Here is the request url pattern: /direct/assignment/deepLinks/{assignment_ref} with parameters {bool_allowRead}, {bool_allowAdd} and {bool_allowSubmit}
item : list (GET) : [/assignment/item] (xml) (json) (form)
Retrieve an assignment specified by the assignment id. The request url pattern: /direct/assignment/item/{assignmentId}.{format}
site : list (GET) : [/assignment/site] (xml) (json) (form)
Retrieve the assignments for a site. The request url pattern: /direct/assignment/site/{siteId}.{format}.gradebookItemId returns data in 3 different format 1) ""- if an assignment is not associated with gradebook 2) "{String-of gradebookItem name}"- when Associate an assignment with existing Gradebook item 3)"/assignment/a/{site_id}/{assignment-id}"- when Adding Assignment to Gradebook.
deepLink : list (GET) : [/assignment/deepLink] (xml) (json) (form)
The action takes assignment reference, returns the deepLink url for current user. Here is the request url pattern: /direct/assignment/deepLinks/{assignment_ref}
my : list (GET) : [/assignment/my] (xml) (json) (form)
Retrieve all my assignments for all of my sites. The request url pattern: /direct/assignment/my.{format}
annc : list (GET) : [/assignment/annc] (xml) (json) (form)
The action takes assignment reference, and returns information about assignment for announcement integration. The assignment information includes assignment object, context, assignmentId, assignmentTitle, assignmentUrl. Here is the request url pattern: /direct/assignment/annc/{assignment_ref} with paramter {messageId}

Entity class : org.sakaiproject.assignment.entityproviders.AssignmentEntityProvider$SimpleAssignment

Type :: bean
Name Type Status
1) accessorg.sakaiproject.assignment.api.Assignment$AssignmentAccessRead/Write
2) allPurposeItemTextstringRead/Write
3) allowResubmissionbooleanRead/Write
4) attachmentsjava.util.ListRead/Write
5) authorLastModifiedstringRead/Write
6) authorsjava.util.ListRead/Write
7) closeTimeorg.sakaiproject.time.api.TimeRead/Write
8) closeTimeStringstringRead/Write
9) contentorg.sakaiproject.assignment.api.AssignmentContentRead/Write
10) contentReferencestringRead/Write
11) contextstringRead/Write
12) creatorstringRead/Write
13) draftbooleanRead/Write
14) dropDeadTimeorg.sakaiproject.time.api.TimeRead/Write
15) dropDeadTimeStringstringRead/Write
16) dueTimeorg.sakaiproject.time.api.TimeRead/Write
17) dueTimeStringstringRead/Write
18) gradeScalestringRead/Write
19) gradeScaleMaxPointsstringRead/Write
20) gradebookItemIdlongRead/Write
21) gradebookItemNamestringRead/Write
22) groupsjava.util.CollectionRead/Write
23) idstringRead/Write
24) instructionsstringRead/Write
25) modelAnswerTextstringRead/Write
26) openTimeorg.sakaiproject.time.api.TimeRead/Write
27) openTimeStringstringRead/Write
28) position_orderintRead/Write
29) privateNoteTextstringRead/Write
30) sectionstringRead/Write
31) statusstringRead/Write
32) submissionTypestringRead/Write
33) timeCreatedorg.sakaiproject.time.api.TimeRead/Write
34) timeLastModifiedorg.sakaiproject.time.api.TimeRead/Write
35) titlestringRead/Write

Data and Request Handling

Output formats : xml, json, form
Input formats : html, xml, json
Access Provider available for request processing : EntityViewAccessProvider
Access Provider available for request processing : EntityViewAccessProvider



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