List
|
|||||
|
|
||||
Returns a list of student submissions that the requester is permitted to
view, factoring in the OAuth scopes of the request.
- may be specified as the course_work_id to include student
submissions for multiple course work items.
Course students may only view their own work. Course teachers and domain administrators may view all student submissions.
This method returns the following error codes:
PERMISSION_DENIEDif the requesting user is not permitted to access the requested course or course work, or for access errors.INVALID_ARGUMENTif the request is malformed.NOT_FOUNDif the requested course does not exist
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your course work and view your grades in Google Classroom
- View your course work and grades in Google Classroom
- Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
- View course work and grades for students in the Google Classroom classes you teach or administer
- View your course work and grades in Google Classroom
- View course work and grades for students in the Google Classroom classes you teach or administer
Input
This building block consumes 7 input parameters
| Name | Format | Description |
|---|---|---|
courseId Required |
STRING |
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
courseWorkId Required |
STRING |
Identifier of the student work to request.
This may be set to the string literal |
userId |
STRING |
Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following:
|
late |
ENUMERATION |
Requested lateness value. If specified, returned student submissions are
restricted by the requested value.
If unspecified, submissions are returned regardless of |
pageToken |
STRING |
nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token |
pageSize |
INTEGER |
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results |
states |
ENUMERATION |
Requested submission states. If specified, returned student submissions match one of the specified submission states |
= Parameter name
= Format
|
courseId STRING Required Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
|
courseWorkId STRING Required Identifier of the student work to request.
This may be set to the string literal |
|
userId STRING Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following:
|
|
late ENUMERATION Requested lateness value. If specified, returned student submissions are
restricted by the requested value.
If unspecified, submissions are returned regardless of |
|
pageToken STRING nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token |
|
pageSize INTEGER Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results |
|
states ENUMERATION Requested submission states. If specified, returned student submissions match one of the specified submission states |
Output
This building block provides 24 output parameters
| Name | Format | Description |
|---|---|---|
nextPageToken |
STRING |
Token identifying the next page of results to return. If empty, no further results are available |
studentSubmissions[] |
OBJECT |
Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with |
studentSubmissions[].draftGrade |
NUMBER |
Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers |
studentSubmissions[].late |
BOOLEAN |
Whether this submission is late. Read-only |
studentSubmissions[].courseWorkType |
ENUMERATION |
Type of course work this submission is for. Read-only |
studentSubmissions[].creationTime |
ANY |
Creation time of this submission. This may be unset if the student has not accessed this item. Read-only |
studentSubmissions[].state |
ENUMERATION |
State of this submission. Read-only |
studentSubmissions[].userId |
STRING |
Identifier for the student that owns this submission. Read-only |
studentSubmissions[].courseWorkId |
STRING |
Identifier for the course work this corresponds to. Read-only |
studentSubmissions[].courseId |
STRING |
Identifier of the course. Read-only |
studentSubmissions[].id |
STRING |
Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only |
studentSubmissions[].submissionHistory[] |
OBJECT |
The history of the submission. This currently includes state and grade histories |
studentSubmissions[].submissionHistory[].stateHistory |
OBJECT |
The history of each state this submission has been in |
studentSubmissions[].submissionHistory[].gradeHistory |
OBJECT |
The history of each grade on this submission |
studentSubmissions[].assignedGrade |
NUMBER |
Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers |
studentSubmissions[].multipleChoiceSubmission |
OBJECT |
Student work for a multiple-choice question |
studentSubmissions[].multipleChoiceSubmission.answer |
STRING |
Student's select choice |
studentSubmissions[].assignmentSubmission |
OBJECT |
Student work for an assignment |
studentSubmissions[].assignmentSubmission.attachments[] |
OBJECT |
Attachment added to student assignment work. When creating attachments, setting the |
studentSubmissions[].associatedWithDeveloper |
BOOLEAN |
Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only |
studentSubmissions[].shortAnswerSubmission |
OBJECT |
Student work for a short answer question |
studentSubmissions[].shortAnswerSubmission.answer |
STRING |
Student response to a short-answer question |
studentSubmissions[].updateTime |
ANY |
Last update time of this submission. This may be unset if the student has not accessed this item. Read-only |
studentSubmissions[].alternateLink |
STRING |
Absolute link to the submission in the Classroom web UI. Read-only |
= Parameter name
= Format
|
nextPageToken STRING Token identifying the next page of results to return. If empty, no further results are available |
|
studentSubmissions[] OBJECT Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with |
|
studentSubmissions[].draftGrade NUMBER Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers |
|
studentSubmissions[].late BOOLEAN Whether this submission is late. Read-only |
|
studentSubmissions[].courseWorkType ENUMERATION Type of course work this submission is for. Read-only |
|
studentSubmissions[].creationTime ANY Creation time of this submission. This may be unset if the student has not accessed this item. Read-only |
|
studentSubmissions[].state ENUMERATION State of this submission. Read-only |
|
studentSubmissions[].userId STRING Identifier for the student that owns this submission. Read-only |
|
studentSubmissions[].courseWorkId STRING Identifier for the course work this corresponds to. Read-only |
|
studentSubmissions[].courseId STRING Identifier of the course. Read-only |
|
studentSubmissions[].id STRING Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only |
|
studentSubmissions[].submissionHistory[] OBJECT The history of the submission. This currently includes state and grade histories |
|
studentSubmissions[].submissionHistory[].stateHistory OBJECT The history of each state this submission has been in |
|
studentSubmissions[].submissionHistory[].gradeHistory OBJECT The history of each grade on this submission |
|
studentSubmissions[].assignedGrade NUMBER Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers |
|
studentSubmissions[].multipleChoiceSubmission OBJECT Student work for a multiple-choice question |
|
studentSubmissions[].multipleChoiceSubmission.answer STRING Student's select choice |
|
studentSubmissions[].assignmentSubmission OBJECT Student work for an assignment |
|
studentSubmissions[].assignmentSubmission.attachments[] OBJECT Attachment added to student assignment work. When creating attachments, setting the |
|
studentSubmissions[].associatedWithDeveloper BOOLEAN Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only |
|
studentSubmissions[].shortAnswerSubmission OBJECT Student work for a short answer question |
|
studentSubmissions[].shortAnswerSubmission.answer STRING Student response to a short-answer question |
|
studentSubmissions[].updateTime ANY Last update time of this submission. This may be unset if the student has not accessed this item. Read-only |
|
studentSubmissions[].alternateLink STRING Absolute link to the submission in the Classroom web UI. Read-only |