| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Classroom.Courses.Students.Get
Description
Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
See: Google Classroom API Reference for classroom.courses.students.get.
- type CoursesStudentsGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` Student))))))))))))
- coursesStudentsGet :: Text -> Text -> CoursesStudentsGet
- data CoursesStudentsGet
- csgXgafv :: Lens' CoursesStudentsGet (Maybe Text)
- csgUploadProtocol :: Lens' CoursesStudentsGet (Maybe Text)
- csgPp :: Lens' CoursesStudentsGet Bool
- csgCourseId :: Lens' CoursesStudentsGet Text
- csgAccessToken :: Lens' CoursesStudentsGet (Maybe Text)
- csgUploadType :: Lens' CoursesStudentsGet (Maybe Text)
- csgUserId :: Lens' CoursesStudentsGet Text
- csgBearerToken :: Lens' CoursesStudentsGet (Maybe Text)
- csgCallback :: Lens' CoursesStudentsGet (Maybe Text)
REST Resource
type CoursesStudentsGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` Student)))))))))))) Source
A resource alias for classroom.courses.students.get method which the
CoursesStudentsGet request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> CoursesStudentsGet |
Creates a value of CoursesStudentsGet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesStudentsGet Source
Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
See: coursesStudentsGet smart constructor.
Request Lenses
csgUploadProtocol :: Lens' CoursesStudentsGet (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
csgPp :: Lens' CoursesStudentsGet Bool Source
Pretty-print response.
csgCourseId :: Lens' CoursesStudentsGet Text Source
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
csgAccessToken :: Lens' CoursesStudentsGet (Maybe Text) Source
OAuth access token.
csgUploadType :: Lens' CoursesStudentsGet (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
csgUserId :: Lens' CoursesStudentsGet Text Source
Identifier of the student to return. 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
csgBearerToken :: Lens' CoursesStudentsGet (Maybe Text) Source
OAuth bearer token.
csgCallback :: Lens' CoursesStudentsGet (Maybe Text) Source
JSONP