Submissions are uniquely identified by a Section ID, Grade Item ID, User ID, and Revision ID.
Table of Contents
Fields
Revision Item
Field | Name | Description | Type | Required |
---|---|---|---|---|
revision_id | Revision ID | A unique identifier grouping a collection of items and representing a single students submission for a single assignment. | integer | |
created | Created | The time the revision was submitted. | integer | |
late | Late | Indicates whether or not this revision was turned in late. | integer | |
num_items | Number of Items | The number of items associated with this revision. | integer | |
draft | Draft | Whether or not the revision is a draft. A user can only have one active draft, and if they have an active draft they cannot create another revision until this draft is submitted or deleted. | integer {0,1} | |
body | Content of Revision | The content of the Revision. This is expected in POST calls to dropbox/assignment_id/create. Otherwise it is not really used. | string |
Operations
create
The {action}
parameter dictates whether a revision with files attached is created, or a revision is created from text or HTML. Files the action is {file}
, creation from text/html the action is {create}
.
-
file action will create a submission from file IDs passed in as file attachments
-
create action will look for a
<body>
attribute in the request body. When using create, keep in mind a user can only have one active revision. If they try to POST a file revision, they will be denied. Also, if the<draft>
flag is not set, the API will default to submitting this revision. If you would like it saved as a draft the<draft>
flag must be set to TRUE. -
File Uploads Accepted
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
POST https://api.schoology.com/v1/dropbox/{grade_item_id}/{action}
Path | |
Content | none |
Return | Revision items and drop item attachments if requested grouped by user JSON XML
|
list
All the Revisions for a requested grade item, sorted by the most recent revision and grouped by user. The following query strings can (optionally) be appended to the path to filter results:
- with_attachments: retrieve attachments of this piece of content.
- all_revisions: optional argument to get all revisions instead of just the most recent one. Accepts a boolean.
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/dropbox/{grade_item_id}/
Path | |
Content | none |
Return | Revision items and drop item attachments if requested grouped by user JSON XML
|
view
Revisions for a given user for a given grade item, sorted by the most recent revision. The following query strings can (optionally) be appended to the path to filter results:
- with_attachments: retrieve attachments of this piece of content.
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}
Path | |
Content | none |
Return | Revision items and drop item attachments if requested JSON XML
|
view
Specific revision for a given user for a given grade item. The following query strings can (optionally) be appended to the path to filter results:
- with_attachments: retrieve attachments of this piece of content.
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}/revision/{revision_id}
Path | |
Content | none |
Return | Revision items and drop item attachments if requested JSON XML
|
delete
Delete assignment submission revision
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
DELETE https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}/revision/{revision_id}
Path | |
Content | none |
Return | none |
Operations - Submission Comments
list
View a list of submission comments for a given user and given grade item id in a section
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}/comments
Path | |
Content | none |
Return | Submission comments JSON XML
|
view
View a specific submission comment for a given user and given grade item id in a section
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}/comments/{comment_id}
Path | |
Content | none |
Return | Submission comment JSON XML
|
delete
Delete a submission comment
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
DELETE https://api.schoology.com/v1/dropbox/{grade_item_id}/{user_id}/comments/{comment_id}
Path | |
Content | none |
Return | none |