-
Notifications
You must be signed in to change notification settings - Fork 10
New GClassroomStudent
Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors.
- `NOT_FOUND` if the requested course ID does not exist.
- `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
New-GClassroomStudent [-CourseId] <String> [[-StudentBody] <Student>] [[-EnrollmentCode] <String>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors.
- `NOT_FOUND` if the requested course ID does not exist.
- `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
PS C:\> New-GClassroomStudent -CourseId $SomeCourseIdString -StudentBody $SomeStudentObj
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.
Identifier of the course to create the student in. 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: FalseStudent in a course.
Type: Student
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseEnrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseIdentifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
Student in a course.
Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads