Copyright | (c) 2015-2016 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 |
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.
See: Google Classroom API Reference for classroom.courses.courseWork.studentSubmissions.list
.
Synopsis
- type CoursesCourseWorkStudentSubmissionsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "courseWorkId" Text :> ("studentSubmissions" :> (QueryParams "states" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "late" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListStudentSubmissionsResponse))))))))))))))))
- coursesCourseWorkStudentSubmissionsList :: Text -> Text -> CoursesCourseWorkStudentSubmissionsList
- data CoursesCourseWorkStudentSubmissionsList
- ccwsslStates :: Lens' CoursesCourseWorkStudentSubmissionsList [Text]
- ccwsslXgafv :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Xgafv)
- ccwsslLate :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslUploadProtocol :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslCourseId :: Lens' CoursesCourseWorkStudentSubmissionsList Text
- ccwsslAccessToken :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslUploadType :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslUserId :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslPageToken :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslPageSize :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Int32)
- ccwsslCallback :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text)
- ccwsslCourseWorkId :: Lens' CoursesCourseWorkStudentSubmissionsList Text
REST Resource
type CoursesCourseWorkStudentSubmissionsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "courseWorkId" Text :> ("studentSubmissions" :> (QueryParams "states" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "late" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListStudentSubmissionsResponse)))))))))))))))) Source #
A resource alias for classroom.courses.courseWork.studentSubmissions.list
method which the
CoursesCourseWorkStudentSubmissionsList
request conforms to.
Creating a Request
coursesCourseWorkStudentSubmissionsList Source #
Creates a value of CoursesCourseWorkStudentSubmissionsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesCourseWorkStudentSubmissionsList Source #
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.
See: coursesCourseWorkStudentSubmissionsList
smart constructor.
Instances
Request Lenses
ccwsslStates :: Lens' CoursesCourseWorkStudentSubmissionsList [Text] Source #
Requested submission states. If specified, returned student submissions match one of the specified submission states.
ccwsslXgafv :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Xgafv) Source #
V1 error format.
ccwsslLate :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
ccwsslUploadProtocol :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
ccwsslCourseId :: Lens' CoursesCourseWorkStudentSubmissionsList Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
ccwsslAccessToken :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
OAuth access token.
ccwsslUploadType :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
ccwsslUserId :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
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
ccwsslPageToken :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #
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.
ccwsslPageSize :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Int32) Source #
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.
ccwsslCourseWorkId :: Lens' CoursesCourseWorkStudentSubmissionsList Text Source #
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.