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

Network.Google.Resource.Classroom.Courses.CourseWork.Patch

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates one or more fields of a course work. See google.classroom.v1.CourseWork 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 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. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

See: Google Classroom API Reference for classroom.courses.courseWork.patch.

Synopsis

type CoursesCourseWorkPatchResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseWork :> Patch '[JSON] CourseWork))))))))))))
coursesCourseWorkPatch :: Text -> CourseWork -> Text -> CoursesCourseWorkPatch
data CoursesCourseWorkPatch
ccwpXgafv :: Lens' CoursesCourseWorkPatch (Maybe Xgafv)
ccwpUploadProtocol :: Lens' CoursesCourseWorkPatch (Maybe Text)
ccwpUpdateMask :: Lens' CoursesCourseWorkPatch (Maybe GFieldMask)
ccwpCourseId :: Lens' CoursesCourseWorkPatch Text
ccwpAccessToken :: Lens' CoursesCourseWorkPatch (Maybe Text)
ccwpUploadType :: Lens' CoursesCourseWorkPatch (Maybe Text)
ccwpPayload :: Lens' CoursesCourseWorkPatch CourseWork
ccwpId :: Lens' CoursesCourseWorkPatch Text
ccwpCallback :: Lens' CoursesCourseWorkPatch (Maybe Text)

REST Resource

type CoursesCourseWorkPatchResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] CourseWork :> Patch '[JSON] CourseWork)))))))))))) Source #

A resource alias for classroom.courses.courseWork.patch method which the CoursesCourseWorkPatch request conforms to.

Creating a Request

coursesCourseWorkPatch Source #

Arguments

:: Text	`ccwpCourseId`
-> CourseWork	`ccwpPayload`
-> Text	`ccwpId`
-> CoursesCourseWorkPatch

Creates a value of CoursesCourseWorkPatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CoursesCourseWorkPatch Source #

Updates one or more fields of a course work. See google.classroom.v1.CourseWork 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 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. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

See: coursesCourseWorkPatch smart constructor.

Instances

Eq CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch Methods (==) :: CoursesCourseWorkPatch -> CoursesCourseWorkPatch -> Bool # (/=) :: CoursesCourseWorkPatch -> CoursesCourseWorkPatch -> Bool #
Data CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesCourseWorkPatch -> c CoursesCourseWorkPatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesCourseWorkPatch # toConstr :: CoursesCourseWorkPatch -> Constr # dataTypeOf :: CoursesCourseWorkPatch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesCourseWorkPatch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesCourseWorkPatch) # gmapT :: (forall b. Data b => b -> b) -> CoursesCourseWorkPatch -> CoursesCourseWorkPatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkPatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkPatch -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesCourseWorkPatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesCourseWorkPatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesCourseWorkPatch -> m CoursesCourseWorkPatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkPatch -> m CoursesCourseWorkPatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkPatch -> m CoursesCourseWorkPatch #
Show CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch Methods showsPrec :: Int -> CoursesCourseWorkPatch -> ShowS # show :: CoursesCourseWorkPatch -> String # showList :: [CoursesCourseWorkPatch] -> ShowS #
Generic CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch Associated Types type Rep CoursesCourseWorkPatch :: Type -> Type # Methods from :: CoursesCourseWorkPatch -> Rep CoursesCourseWorkPatch x # to :: Rep CoursesCourseWorkPatch x -> CoursesCourseWorkPatch #
GoogleRequest CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch Associated Types type Rs CoursesCourseWorkPatch :: Type # type Scopes CoursesCourseWorkPatch :: [Symbol] # Methods requestClient :: CoursesCourseWorkPatch -> GClient (Rs CoursesCourseWorkPatch) #
type Rep CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch type Rep CoursesCourseWorkPatch = D1 (MetaData "CoursesCourseWorkPatch" "Network.Google.Resource.Classroom.Courses.CourseWork.Patch" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesCourseWorkPatch'" PrefixI True) (((S1 (MetaSel (Just "_ccwpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_ccwpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ccwpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :: S1 (MetaSel (Just "_ccwpCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_ccwpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ccwpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ccwpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CourseWork) :: (S1 (MetaSel (Just "_ccwpId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ccwpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch type Scopes CoursesCourseWorkPatch = "https://www.googleapis.com/auth/classroom.coursework.students" ': ([] :: [Symbol])
type Rs CoursesCourseWorkPatch Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.CourseWork.Patch type Rs CoursesCourseWorkPatch = CourseWork

Request Lenses

ccwpXgafv :: Lens' CoursesCourseWorkPatch (Maybe Xgafv) Source #

V1 error format.

ccwpUploadProtocol :: Lens' CoursesCourseWorkPatch (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

ccwpUpdateMask :: Lens' CoursesCourseWorkPatch (Maybe GFieldMask) Source #

Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode`

ccwpCourseId :: Lens' CoursesCourseWorkPatch Text Source #

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

ccwpAccessToken :: Lens' CoursesCourseWorkPatch (Maybe Text) Source #

OAuth access token.

ccwpUploadType :: Lens' CoursesCourseWorkPatch (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

ccwpPayload :: Lens' CoursesCourseWorkPatch CourseWork Source #

Multipart request metadata.

ccwpId :: Lens' CoursesCourseWorkPatch Text Source #

Identifier of the course work.

ccwpCallback :: Lens' CoursesCourseWorkPatch (Maybe Text) Source #

JSONP