class CoursesCourseWorkStudentSubmissions extends Resource (View source)

The "studentSubmissions" collection of methods.

Typical usage is:

 $classroomService = new Google\Service\Classroom(...);
 $studentSubmissions = $classroomService->courses_courseWork_studentSubmissions;

Methods

get(string $courseId, string $courseWorkId, string $id, array $optParams = [])

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. (studentSubmissions.get)

listCoursesCourseWorkStudentSubmissions(string $courseId, string $courseWorkId, array $optParams = [])

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.

modifyAttachments(string $courseId, string $courseWorkId, string $id, ModifyAttachmentsRequest $postBody, array $optParams = [])

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 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. (studentSubmissions.modifyAttachments)

patch(string $courseId, string $courseWorkId, string $id, StudentSubmission $postBody, array $optParams = [])

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 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.

reclaim(string $courseId, string $courseWorkId, string $id, ReclaimStudentSubmissionRequest $postBody, array $optParams = [])

Reclaims a student submission on behalf of the student that owns it.

returnCoursesCourseWorkStudentSubmissions(string $courseId, string $courseWorkId, string $id, ReturnStudentSubmissionRequest $postBody, array $optParams = [])

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 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.

turnIn(string $courseId, string $courseWorkId, string $id, TurnInStudentSubmissionRequest $postBody, array $optParams = [])

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 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. (studentSubmissions.turnIn)

Details

StudentSubmission get(string $courseId, string $courseWorkId, string $id, array $optParams = [])

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. (studentSubmissions.get)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

array $optParams

Optional parameters.

Return Value

StudentSubmission

Exceptions

Exception

ListStudentSubmissionsResponse listCoursesCourseWorkStudentSubmissions(string $courseId, string $courseWorkId, array $optParams = [])

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.

(studentSubmissions.listCoursesCourseWorkStudentSubmissions)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

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.

array $optParams

Optional parameters.

Return Value

ListStudentSubmissionsResponse

Exceptions

Exception

StudentSubmission modifyAttachments(string $courseId, string $courseWorkId, string $id, ModifyAttachmentsRequest $postBody, array $optParams = [])

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 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. (studentSubmissions.modifyAttachments)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

ModifyAttachmentsRequest $postBody
array $optParams

Optional parameters.

Return Value

StudentSubmission

Exceptions

Exception

StudentSubmission patch(string $courseId, string $courseWorkId, string $id, StudentSubmission $postBody, array $optParams = [])

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 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.

(studentSubmissions.patch)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

StudentSubmission $postBody
array $optParams

Optional parameters.

Return Value

StudentSubmission

Exceptions

Exception

ClassroomEmpty reclaim(string $courseId, string $courseWorkId, string $id, ReclaimStudentSubmissionRequest $postBody, array $optParams = [])

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 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. (studentSubmissions.reclaim)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

ReclaimStudentSubmissionRequest $postBody
array $optParams

Optional parameters.

Return Value

ClassroomEmpty

Exceptions

Exception

ClassroomEmpty returnCoursesCourseWorkStudentSubmissions(string $courseId, string $courseWorkId, string $id, ReturnStudentSubmissionRequest $postBody, array $optParams = [])

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 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.

(studentSubmissions.returnCoursesCourseWorkStudentSubmissions)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

ReturnStudentSubmissionRequest $postBody
array $optParams

Optional parameters.

Return Value

ClassroomEmpty

Exceptions

Exception

ClassroomEmpty turnIn(string $courseId, string $courseWorkId, string $id, TurnInStudentSubmissionRequest $postBody, array $optParams = [])

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 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. (studentSubmissions.turnIn)

Parameters

string $courseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

string $courseWorkId

Identifier of the course work.

string $id

Identifier of the student submission.

TurnInStudentSubmissionRequest $postBody
array $optParams

Optional parameters.

Return Value

ClassroomEmpty

Exceptions

Exception