Overview

Classes

  • Google_Service_Classroom
  • Google_Service_Classroom_Announcement
  • Google_Service_Classroom_Assignment
  • Google_Service_Classroom_AssignmentSubmission
  • Google_Service_Classroom_Attachment
  • Google_Service_Classroom_ClassroomEmpty
  • Google_Service_Classroom_CloudPubsubTopic
  • Google_Service_Classroom_Course
  • Google_Service_Classroom_CourseAlias
  • Google_Service_Classroom_CourseMaterial
  • Google_Service_Classroom_CourseMaterialSet
  • Google_Service_Classroom_CourseRosterChangesInfo
  • Google_Service_Classroom_Courses_Resource
  • Google_Service_Classroom_CoursesAliases_Resource
  • Google_Service_Classroom_CoursesAnnouncements_Resource
  • Google_Service_Classroom_CoursesCourseWork_Resource
  • Google_Service_Classroom_CoursesCourseWorkStudentSubmissions_Resource
  • Google_Service_Classroom_CoursesStudents_Resource
  • Google_Service_Classroom_CoursesTeachers_Resource
  • Google_Service_Classroom_CoursesTopics_Resource
  • Google_Service_Classroom_CourseWork
  • Google_Service_Classroom_CourseWorkChangesInfo
  • Google_Service_Classroom_Date
  • Google_Service_Classroom_DriveFile
  • Google_Service_Classroom_DriveFolder
  • Google_Service_Classroom_Feed
  • Google_Service_Classroom_Form
  • Google_Service_Classroom_GlobalPermission
  • Google_Service_Classroom_GradeHistory
  • Google_Service_Classroom_Guardian
  • Google_Service_Classroom_GuardianInvitation
  • Google_Service_Classroom_IndividualStudentsOptions
  • Google_Service_Classroom_Invitation
  • Google_Service_Classroom_Invitations_Resource
  • Google_Service_Classroom_Link
  • Google_Service_Classroom_ListAnnouncementsResponse
  • Google_Service_Classroom_ListCourseAliasesResponse
  • Google_Service_Classroom_ListCoursesResponse
  • Google_Service_Classroom_ListCourseWorkResponse
  • Google_Service_Classroom_ListGuardianInvitationsResponse
  • Google_Service_Classroom_ListGuardiansResponse
  • Google_Service_Classroom_ListInvitationsResponse
  • Google_Service_Classroom_ListStudentsResponse
  • Google_Service_Classroom_ListStudentSubmissionsResponse
  • Google_Service_Classroom_ListTeachersResponse
  • Google_Service_Classroom_ListTopicResponse
  • Google_Service_Classroom_Material
  • Google_Service_Classroom_ModifyAnnouncementAssigneesRequest
  • Google_Service_Classroom_ModifyAttachmentsRequest
  • Google_Service_Classroom_ModifyCourseWorkAssigneesRequest
  • Google_Service_Classroom_ModifyIndividualStudentsOptions
  • Google_Service_Classroom_MultipleChoiceQuestion
  • Google_Service_Classroom_MultipleChoiceSubmission
  • Google_Service_Classroom_Name
  • Google_Service_Classroom_ReclaimStudentSubmissionRequest
  • Google_Service_Classroom_Registration
  • Google_Service_Classroom_Registrations_Resource
  • Google_Service_Classroom_ReturnStudentSubmissionRequest
  • Google_Service_Classroom_SharedDriveFile
  • Google_Service_Classroom_ShortAnswerSubmission
  • Google_Service_Classroom_StateHistory
  • Google_Service_Classroom_Student
  • Google_Service_Classroom_StudentSubmission
  • Google_Service_Classroom_SubmissionHistory
  • Google_Service_Classroom_Teacher
  • Google_Service_Classroom_TimeOfDay
  • Google_Service_Classroom_Topic
  • Google_Service_Classroom_TurnInStudentSubmissionRequest
  • Google_Service_Classroom_UserProfile
  • Google_Service_Classroom_UserProfiles_Resource
  • Google_Service_Classroom_UserProfilesGuardianInvitations_Resource
  • Google_Service_Classroom_UserProfilesGuardians_Resource
  • Google_Service_Classroom_YouTubeVideo
  • Overview
  • Class
  • Tree

Class Google_Service_Classroom_CoursesCourseWorkStudentSubmissions_Resource

The "studentSubmissions" collection of methods. Typical usage is:

 $classroomService = new Google_Service_Classroom(...);
 $studentSubmissions = $classroomService->studentSubmissions;
Google_Service_Resource
Extended by Google_Service_Classroom_CoursesCourseWorkStudentSubmissions_Resource
Located at Classroom.php
Methods summary
public Google_Service_Classroom_StudentSubmission
# get( string $courseId, string $courseWorkId, string $id, array $optParams = array() )

Returns a student submission.

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

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$optParams
Optional parameters.

Returns

Google_Service_Classroom_StudentSubmission
Google_Service_Classroom_StudentSubmission
public Google_Service_Classroom_ListStudentSubmissionsResponse
# listCoursesCourseWorkStudentSubmissions( string $courseId, string $courseWorkId, array $optParams = array() )

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.

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

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the student work to request. This may be set to the string literal <code>"-"</code> to request student work for all course work in the specified course.
$optParams
Optional parameters.

Returns

Google_Service_Classroom_ListStudentSubmissionsResponse
Google_Service_Classroom_ListStudentSubmissionsResponse

Opt_param

string userId 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
string late Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of late value.
string pageToken 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.
string states Requested submission states. If specified, returned student submissions match one of the specified submission states.
int pageSize 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.
public Google_Service_Classroom_StudentSubmission
# modifyAttachments( string $courseId, string $courseWorkId, string $id, Google_Service_Classroom_ModifyAttachmentsRequest $postBody, array $optParams = array() )

Modifies attachments of student submission.

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

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_StudentSubmission
Google_Service_Classroom_StudentSubmission
public Google_Service_Classroom_StudentSubmission
# patch( string $courseId, string $courseWorkId, string $id, Google_Service_Classroom_StudentSubmission $postBody, array $optParams = array() )

Updates one or more fields of a student submission.

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

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_StudentSubmission
Google_Service_Classroom_StudentSubmission

Opt_param

string updateMask 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
public Google_Service_Classroom_ClassroomEmpty
# reclaim( string $courseId, string $courseWorkId, string $id, Google_Service_Classroom_ReclaimStudentSubmissionRequest $postBody, array $optParams = array() )

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

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

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_ClassroomEmpty
Google_Service_Classroom_ClassroomEmpty
public Google_Service_Classroom_ClassroomEmpty
# returnCoursesCourseWorkStudentSubmissions( string $courseId, string $courseWorkId, string $id, Google_Service_Classroom_ReturnStudentSubmissionRequest $postBody, array $optParams = array() )

Returns a student submission.

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

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_ClassroomEmpty
Google_Service_Classroom_ClassroomEmpty
public Google_Service_Classroom_ClassroomEmpty
# turnIn( string $courseId, string $courseWorkId, string $id, Google_Service_Classroom_TurnInStudentSubmissionRequest $postBody, array $optParams = array() )

Turns in a student submission.

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

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$courseWorkId
Identifier of the course work.
$id
Identifier of the student submission.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_ClassroomEmpty
Google_Service_Classroom_ClassroomEmpty
© 2020 Google Inc.
Google Classroom API documentation generated by ApiGen 2.8.0