Skip to content

Set GClassroomStudentSubmission

Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Set-GClassroomStudentSubmission

SYNOPSIS

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.

SYNTAX

update (Default)

Set-GClassroomStudentSubmission [-CourseId] <String> [-CourseWorkId] <String> [-Id] <String>
 [[-StudentSubmissionBody] <StudentSubmission>] [[-UpdateMask] <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

reclaim

Set-GClassroomStudentSubmission [-CourseId] <String> [-CourseWorkId] <String> [-Id] <String> [-Reclaim]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

return

Set-GClassroomStudentSubmission [-CourseId] <String> [-CourseWorkId] <String> [-Id] <String> [-Return]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

turnIn

Set-GClassroomStudentSubmission [-CourseId] <String> [-CourseWorkId] <String> [-Id] <String> [-TurnIn]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

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.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Set-GClassroomStudentSubmission -CourseId $SomeCourseIdString -CourseWorkId $SomeCourseWorkIdString -Id $SomeIdString -StudentSubmissionBody $SomeStudentSubmissionObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 2 ----------

PS C:\> Set-GClassroomStudentSubmission -CourseId $SomeCourseIdString -CourseWorkId $SomeCourseWorkIdString -Id $SomeIdString -Reclaim

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 3 ----------

PS C:\> Set-GClassroomStudentSubmission -CourseId $SomeCourseIdString -CourseWorkId $SomeCourseWorkIdString -Id $SomeIdString -Return

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 4 ----------

PS C:\> Set-GClassroomStudentSubmission -CourseId $SomeCourseIdString -CourseWorkId $SomeCourseWorkIdString -Id $SomeIdString -TurnIn

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-CourseId

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CourseWorkId

Identifier of the course work.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Identifier of the student submission.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StudentSubmissionBody

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.

Type: StudentSubmission
Parameter Sets: update
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

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

Type: String
Parameter Sets: update
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Reclaim

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 update the submission state. Only the student that ownes 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.
Type: SwitchParameter
Parameter Sets: reclaim
Aliases: 

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Return

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.
Type: SwitchParameter
Parameter Sets: return
Aliases: 

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TurnIn

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.
Type: SwitchParameter
Parameter Sets: turnIn
Aliases: 

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

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

System.String

Identifier of the course work.

System.String

Identifier of the student submission.

Google.Apis.Classroom.v1.Data.StudentSubmission

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.

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

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally