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]:
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}
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}
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}
setGrade :
new (POST) :
[/assignment/setGrade]
Entity class : org.sakaiproject.assignment.entityproviders.AssignmentEntityProvider$SimpleAssignment
Type :: bean
|
Name |
Type |
Status |
1) | access | string | Read/Write |
2) | allPurposeItemText | string | Read/Write |
3) | allowPeerAssessment | boolean | Read/Write |
4) | allowResubmission | boolean | Read/Write |
5) | anonymousGrading | boolean | Read/Write |
6) | attachments | java.util.List | Read/Write |
7) | author | string | Read/Write |
8) | authorLastModified | string | Read/Write |
9) | closeTime | java.time.Instant | Read/Write |
10) | closeTimeString | string | Read/Write |
11) | content | org.sakaiproject.assignment.api.model.Assignment | Read/Write |
12) | context | string | Read/Write |
13) | creator | string | Read/Write |
14) | draft | boolean | Read/Write |
15) | dropDeadTime | java.time.Instant | Read/Write |
16) | dropDeadTimeString | string | Read/Write |
17) | dueTime | java.time.Instant | Read/Write |
18) | dueTimeString | string | Read/Write |
19) | estimate | string | Read/Write |
20) | estimateRequired | boolean | Read/Write |
21) | gradeScale | string | Read/Write |
22) | gradeScaleMaxPoints | string | Read/Write |
23) | gradebookItemId | long | Read/Write |
24) | gradebookItemName | string | Read/Write |
25) | groups | java.util.Collection | Read/Write |
26) | id | string | Read/Write |
27) | instructions | string | Read/Write |
28) | ltiGradableLaunch | string | Read/Write |
29) | maxGradePoint | string | Read/Write |
30) | modelAnswerText | string | Read/Write |
31) | openTime | java.time.Instant | Read/Write |
32) | openTimeString | string | Read/Write |
33) | position | int | Read/Write |
34) | privateNoteText | string | Read/Write |
35) | section | string | Read/Write |
36) | status | string | Read/Write |
37) | submissionType | string | Read/Write |
38) | submissions | java.util.List | Read/Write |
39) | timeCreated | java.time.Instant | Read/Write |
40) | timeLastModified | java.time.Instant | Read/Write |
41) | title | string | Read/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
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 | Inputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable | |
7 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
8 | PropertyProvideable | org.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable | |
9 | Propertyable | org.sakaiproject.entitybroker.entityprovider.capabilities.Propertyable | |
10 | Resolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable | |
11 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$