1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.courseWork.html">courseWork</a> . <a href="classroom_v1.courses.courseWork.studentSubmissions.html">studentSubmissions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(courseId, courseWorkId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(courseId, courseWorkId, late=None, pageSize=None, pageToken=None, states=None, userId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">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_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(courseId, courseWorkId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 95<p class="toc_element"> 96 <code><a href="#reclaim">reclaim(courseId, courseWorkId, id, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 98<p class="toc_element"> 99 <code><a href="#return_">return_(courseId, courseWorkId, id, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 101<p class="toc_element"> 102 <code><a href="#turnIn">turnIn(courseId, courseWorkId, id, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="get">get(courseId, courseWorkId, id, x__xgafv=None)</code> 112 <pre>Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 113 114Args: 115 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 116 courseWorkId: string, Identifier of the course work. (required) 117 id: string, Identifier of the student submission. (required) 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122 123Returns: 124 An object of the form: 125 126 { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. 127 "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only. 128 "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. 129 "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. 130 "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. 131 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 132 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 133 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 134 "id": "A String", # Drive API resource ID. 135 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 136 "title": "A String", # Title of the Drive item. Read-only. 137 }, 138 "form": { # Google Forms item. # Google Forms attachment. 139 "formUrl": "A String", # URL of the form. 140 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 141 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 142 "title": "A String", # Title of the Form. Read-only. 143 }, 144 "link": { # URL item. # Link attachment. 145 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 146 "title": "A String", # Title of the target of the URL. Read-only. 147 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 148 }, 149 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 150 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 151 "id": "A String", # YouTube API resource ID. 152 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 153 "title": "A String", # Title of the YouTube video. Read-only. 154 }, 155 }, 156 ], 157 }, 158 "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 159 "courseId": "A String", # Identifier of the course. Read-only. 160 "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only. 161 "courseWorkType": "A String", # Type of course work this submission is for. Read-only. 162 "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. 163 "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. 164 "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. 165 "late": True or False, # Whether this submission is late. Read-only. 166 "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. 167 "answer": "A String", # Student's select choice. 168 }, 169 "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION. 170 "answer": "A String", # Student response to a short-answer question. 171 }, 172 "state": "A String", # State of this submission. Read-only. 173 "submissionHistory": [ # The history of the submission (includes state and grade histories). Read-only. 174 { # The history of the submission. This currently includes state and grade histories. 175 "gradeHistory": { # The history of each grade on this submission. # The grade history information of the submission, if present. 176 "actorUserId": "A String", # The teacher who made the grade change. 177 "gradeChangeType": "A String", # The type of grade change at this time in the submission grade history. 178 "gradeTimestamp": "A String", # When the grade of the submission was changed. 179 "maxPoints": 3.14, # The denominator of the grade at this time in the submission grade history. 180 "pointsEarned": 3.14, # The numerator of the grade at this time in the submission grade history. 181 }, 182 "stateHistory": { # The history of each state this submission has been in. # The state history information of the submission, if present. 183 "actorUserId": "A String", # The teacher or student who made the change. 184 "state": "A String", # The workflow pipeline stage. 185 "stateTimestamp": "A String", # When the submission entered this state. 186 }, 187 }, 188 ], 189 "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. 190 "userId": "A String", # Identifier for the student that owns this submission. Read-only. 191}</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="list">list(courseId, courseWorkId, late=None, pageSize=None, pageToken=None, states=None, userId=None, x__xgafv=None)</code> 196 <pre>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_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. 197 198Args: 199 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 200 courseWorkId: string, Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. (required) 201 late: string, Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value. 202 Allowed values 203 LATE_VALUES_UNSPECIFIED - No restriction on submission late values specified. 204 LATE_ONLY - Return StudentSubmissions where late is true. 205 NOT_LATE_ONLY - Return StudentSubmissions where late is false. 206 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. 207 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. 208 states: string, Requested submission states. If specified, returned student submissions match one of the specified submission states. (repeated) 209 Allowed values 210 SUBMISSION_STATE_UNSPECIFIED - No state specified. This should never be returned. 211 NEW - The student has never accessed this submission. Attachments are not returned and timestamps is not set. 212 CREATED - Has been created. 213 TURNED_IN - Has been turned in to the teacher. 214 RETURNED - Has been returned to the student. 215 RECLAIMED_BY_STUDENT - Student chose to "unsubmit" the assignment. 216 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: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # Response when listing student submissions. 226 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. 227 "studentSubmissions": [ # Student work that matches the request. 228 { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. 229 "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only. 230 "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. 231 "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. 232 "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. 233 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 234 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 235 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 236 "id": "A String", # Drive API resource ID. 237 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 238 "title": "A String", # Title of the Drive item. Read-only. 239 }, 240 "form": { # Google Forms item. # Google Forms attachment. 241 "formUrl": "A String", # URL of the form. 242 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 243 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 244 "title": "A String", # Title of the Form. Read-only. 245 }, 246 "link": { # URL item. # Link attachment. 247 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 248 "title": "A String", # Title of the target of the URL. Read-only. 249 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 250 }, 251 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 252 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 253 "id": "A String", # YouTube API resource ID. 254 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 255 "title": "A String", # Title of the YouTube video. Read-only. 256 }, 257 }, 258 ], 259 }, 260 "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 261 "courseId": "A String", # Identifier of the course. Read-only. 262 "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only. 263 "courseWorkType": "A String", # Type of course work this submission is for. Read-only. 264 "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. 265 "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. 266 "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. 267 "late": True or False, # Whether this submission is late. Read-only. 268 "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. 269 "answer": "A String", # Student's select choice. 270 }, 271 "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION. 272 "answer": "A String", # Student response to a short-answer question. 273 }, 274 "state": "A String", # State of this submission. Read-only. 275 "submissionHistory": [ # The history of the submission (includes state and grade histories). Read-only. 276 { # The history of the submission. This currently includes state and grade histories. 277 "gradeHistory": { # The history of each grade on this submission. # The grade history information of the submission, if present. 278 "actorUserId": "A String", # The teacher who made the grade change. 279 "gradeChangeType": "A String", # The type of grade change at this time in the submission grade history. 280 "gradeTimestamp": "A String", # When the grade of the submission was changed. 281 "maxPoints": 3.14, # The denominator of the grade at this time in the submission grade history. 282 "pointsEarned": 3.14, # The numerator of the grade at this time in the submission grade history. 283 }, 284 "stateHistory": { # The history of each state this submission has been in. # The state history information of the submission, if present. 285 "actorUserId": "A String", # The teacher or student who made the change. 286 "state": "A String", # The workflow pipeline stage. 287 "stateTimestamp": "A String", # When the submission entered this state. 288 }, 289 }, 290 ], 291 "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. 292 "userId": "A String", # Identifier for the student that owns this submission. Read-only. 293 }, 294 ], 295}</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 300 <pre>Retrieves the next page of results. 301 302Args: 303 previous_request: The request for the previous page. (required) 304 previous_response: The response from the request for the previous page. (required) 305 306Returns: 307 A request object that you can call 'execute()' on to request the next 308 page. Returns None if there are no more items in the collection. 309 </pre> 310</div> 311 312<div class="method"> 313 <code class="details" id="modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body=None, x__xgafv=None)</code> 314 <pre>Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 315 316Args: 317 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 318 courseWorkId: string, Identifier of the course work. (required) 319 id: string, Identifier of the student submission. (required) 320 body: object, The request body. 321 The object takes the form of: 322 323{ # Request to modify the attachments of a student submission. 324 "addAttachments": [ # Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported. 325 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 326 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 327 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 328 "id": "A String", # Drive API resource ID. 329 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 330 "title": "A String", # Title of the Drive item. Read-only. 331 }, 332 "form": { # Google Forms item. # Google Forms attachment. 333 "formUrl": "A String", # URL of the form. 334 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 335 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 336 "title": "A String", # Title of the Form. Read-only. 337 }, 338 "link": { # URL item. # Link attachment. 339 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 340 "title": "A String", # Title of the target of the URL. Read-only. 341 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 342 }, 343 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 344 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 345 "id": "A String", # YouTube API resource ID. 346 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 347 "title": "A String", # Title of the YouTube video. Read-only. 348 }, 349 }, 350 ], 351} 352 353 x__xgafv: string, V1 error format. 354 Allowed values 355 1 - v1 error format 356 2 - v2 error format 357 358Returns: 359 An object of the form: 360 361 { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. 362 "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only. 363 "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. 364 "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. 365 "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. 366 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 367 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 368 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 369 "id": "A String", # Drive API resource ID. 370 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 371 "title": "A String", # Title of the Drive item. Read-only. 372 }, 373 "form": { # Google Forms item. # Google Forms attachment. 374 "formUrl": "A String", # URL of the form. 375 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 376 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 377 "title": "A String", # Title of the Form. Read-only. 378 }, 379 "link": { # URL item. # Link attachment. 380 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 381 "title": "A String", # Title of the target of the URL. Read-only. 382 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 383 }, 384 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 385 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 386 "id": "A String", # YouTube API resource ID. 387 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 388 "title": "A String", # Title of the YouTube video. Read-only. 389 }, 390 }, 391 ], 392 }, 393 "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 394 "courseId": "A String", # Identifier of the course. Read-only. 395 "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only. 396 "courseWorkType": "A String", # Type of course work this submission is for. Read-only. 397 "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. 398 "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. 399 "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. 400 "late": True or False, # Whether this submission is late. Read-only. 401 "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. 402 "answer": "A String", # Student's select choice. 403 }, 404 "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION. 405 "answer": "A String", # Student response to a short-answer question. 406 }, 407 "state": "A String", # State of this submission. Read-only. 408 "submissionHistory": [ # The history of the submission (includes state and grade histories). Read-only. 409 { # The history of the submission. This currently includes state and grade histories. 410 "gradeHistory": { # The history of each grade on this submission. # The grade history information of the submission, if present. 411 "actorUserId": "A String", # The teacher who made the grade change. 412 "gradeChangeType": "A String", # The type of grade change at this time in the submission grade history. 413 "gradeTimestamp": "A String", # When the grade of the submission was changed. 414 "maxPoints": 3.14, # The denominator of the grade at this time in the submission grade history. 415 "pointsEarned": 3.14, # The numerator of the grade at this time in the submission grade history. 416 }, 417 "stateHistory": { # The history of each state this submission has been in. # The state history information of the submission, if present. 418 "actorUserId": "A String", # The teacher or student who made the change. 419 "state": "A String", # The workflow pipeline stage. 420 "stateTimestamp": "A String", # When the submission entered this state. 421 }, 422 }, 423 ], 424 "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. 425 "userId": "A String", # Identifier for the student that owns this submission. Read-only. 426}</pre> 427</div> 428 429<div class="method"> 430 <code class="details" id="patch">patch(courseId, courseWorkId, id, body=None, updateMask=None, x__xgafv=None)</code> 431 <pre>Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 432 433Args: 434 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 435 courseWorkId: string, Identifier of the course work. (required) 436 id: string, Identifier of the student submission. (required) 437 body: object, The request body. 438 The object takes the form of: 439 440{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. 441 "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only. 442 "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. 443 "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. 444 "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. 445 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 446 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 447 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 448 "id": "A String", # Drive API resource ID. 449 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 450 "title": "A String", # Title of the Drive item. Read-only. 451 }, 452 "form": { # Google Forms item. # Google Forms attachment. 453 "formUrl": "A String", # URL of the form. 454 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 455 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 456 "title": "A String", # Title of the Form. Read-only. 457 }, 458 "link": { # URL item. # Link attachment. 459 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 460 "title": "A String", # Title of the target of the URL. Read-only. 461 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 462 }, 463 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 464 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 465 "id": "A String", # YouTube API resource ID. 466 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 467 "title": "A String", # Title of the YouTube video. Read-only. 468 }, 469 }, 470 ], 471 }, 472 "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 473 "courseId": "A String", # Identifier of the course. Read-only. 474 "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only. 475 "courseWorkType": "A String", # Type of course work this submission is for. Read-only. 476 "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. 477 "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. 478 "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. 479 "late": True or False, # Whether this submission is late. Read-only. 480 "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. 481 "answer": "A String", # Student's select choice. 482 }, 483 "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION. 484 "answer": "A String", # Student response to a short-answer question. 485 }, 486 "state": "A String", # State of this submission. Read-only. 487 "submissionHistory": [ # The history of the submission (includes state and grade histories). Read-only. 488 { # The history of the submission. This currently includes state and grade histories. 489 "gradeHistory": { # The history of each grade on this submission. # The grade history information of the submission, if present. 490 "actorUserId": "A String", # The teacher who made the grade change. 491 "gradeChangeType": "A String", # The type of grade change at this time in the submission grade history. 492 "gradeTimestamp": "A String", # When the grade of the submission was changed. 493 "maxPoints": 3.14, # The denominator of the grade at this time in the submission grade history. 494 "pointsEarned": 3.14, # The numerator of the grade at this time in the submission grade history. 495 }, 496 "stateHistory": { # The history of each state this submission has been in. # The state history information of the submission, if present. 497 "actorUserId": "A String", # The teacher or student who made the change. 498 "state": "A String", # The workflow pipeline stage. 499 "stateTimestamp": "A String", # When the submission entered this state. 500 }, 501 }, 502 ], 503 "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. 504 "userId": "A String", # Identifier for the student that owns this submission. Read-only. 505} 506 507 updateMask: string, Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade` 508 x__xgafv: string, V1 error format. 509 Allowed values 510 1 - v1 error format 511 2 - v2 error format 512 513Returns: 514 An object of the form: 515 516 { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time. 517 "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only. 518 "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. 519 "assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. 520 "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. 521 { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported. 522 "driveFile": { # Representation of a Google Drive file. # Google Drive file attachment. 523 "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. 524 "id": "A String", # Drive API resource ID. 525 "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. 526 "title": "A String", # Title of the Drive item. Read-only. 527 }, 528 "form": { # Google Forms item. # Google Forms attachment. 529 "formUrl": "A String", # URL of the form. 530 "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only. 531 "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. 532 "title": "A String", # Title of the Form. Read-only. 533 }, 534 "link": { # URL item. # Link attachment. 535 "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. 536 "title": "A String", # Title of the target of the URL. Read-only. 537 "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. 538 }, 539 "youTubeVideo": { # YouTube video item. # Youtube video attachment. 540 "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. 541 "id": "A String", # YouTube API resource ID. 542 "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. 543 "title": "A String", # Title of the YouTube video. Read-only. 544 }, 545 }, 546 ], 547 }, 548 "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. 549 "courseId": "A String", # Identifier of the course. Read-only. 550 "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only. 551 "courseWorkType": "A String", # Type of course work this submission is for. Read-only. 552 "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only. 553 "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. 554 "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only. 555 "late": True or False, # Whether this submission is late. Read-only. 556 "multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION. 557 "answer": "A String", # Student's select choice. 558 }, 559 "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION. 560 "answer": "A String", # Student response to a short-answer question. 561 }, 562 "state": "A String", # State of this submission. Read-only. 563 "submissionHistory": [ # The history of the submission (includes state and grade histories). Read-only. 564 { # The history of the submission. This currently includes state and grade histories. 565 "gradeHistory": { # The history of each grade on this submission. # The grade history information of the submission, if present. 566 "actorUserId": "A String", # The teacher who made the grade change. 567 "gradeChangeType": "A String", # The type of grade change at this time in the submission grade history. 568 "gradeTimestamp": "A String", # When the grade of the submission was changed. 569 "maxPoints": 3.14, # The denominator of the grade at this time in the submission grade history. 570 "pointsEarned": 3.14, # The numerator of the grade at this time in the submission grade history. 571 }, 572 "stateHistory": { # The history of each state this submission has been in. # The state history information of the submission, if present. 573 "actorUserId": "A String", # The teacher or student who made the change. 574 "state": "A String", # The workflow pipeline stage. 575 "stateTimestamp": "A String", # When the submission entered this state. 576 }, 577 }, 578 ], 579 "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only. 580 "userId": "A String", # Identifier for the student that owns this submission. Read-only. 581}</pre> 582</div> 583 584<div class="method"> 585 <code class="details" id="reclaim">reclaim(courseId, courseWorkId, id, body=None, x__xgafv=None)</code> 586 <pre>Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 587 588Args: 589 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 590 courseWorkId: string, Identifier of the course work. (required) 591 id: string, Identifier of the student submission. (required) 592 body: object, The request body. 593 The object takes the form of: 594 595{ # Request to reclaim a student submission. 596} 597 598 x__xgafv: string, V1 error format. 599 Allowed values 600 1 - v1 error format 601 2 - v2 error format 602 603Returns: 604 An object of the form: 605 606 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 607}</pre> 608</div> 609 610<div class="method"> 611 <code class="details" id="return_">return_(courseId, courseWorkId, id, body=None, x__xgafv=None)</code> 612 <pre>Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 613 614Args: 615 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 616 courseWorkId: string, Identifier of the course work. (required) 617 id: string, Identifier of the student submission. (required) 618 body: object, The request body. 619 The object takes the form of: 620 621{ # Request to return a student submission. 622} 623 624 x__xgafv: string, V1 error format. 625 Allowed values 626 1 - v1 error format 627 2 - v2 error format 628 629Returns: 630 An object of the form: 631 632 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 633}</pre> 634</div> 635 636<div class="method"> 637 <code class="details" id="turnIn">turnIn(courseId, courseWorkId, id, body=None, x__xgafv=None)</code> 638 <pre>Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. 639 640Args: 641 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 642 courseWorkId: string, Identifier of the course work. (required) 643 id: string, Identifier of the student submission. (required) 644 body: object, The request body. 645 The object takes the form of: 646 647{ # Request to turn in a student submission. 648} 649 650 x__xgafv: string, V1 error format. 651 Allowed values 652 1 - v1 error format 653 2 - v2 error format 654 655Returns: 656 An object of the form: 657 658 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 659}</pre> 660</div> 661 662</body></html>