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

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.

REST Resource

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

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

Creating a Request

coursesCourseWorkPatch

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:

• ccwpXgafv
• ccwpUploadProtocol
• ccwpUpdateMask
• ccwpPp
• ccwpCourseId
• ccwpAccessToken
• ccwpUploadType
• ccwpPayload
• ccwpBearerToken
• ccwpId
• ccwpCallback

data CoursesCourseWorkPatch

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

Methods

(==) :: CoursesCourseWorkPatch -> CoursesCourseWorkPatch -> Bool

(/=) :: CoursesCourseWorkPatch -> CoursesCourseWorkPatch -> Bool

Data CoursesCourseWorkPatch

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

Methods

showsPrec :: Int -> CoursesCourseWorkPatch -> ShowS

show :: CoursesCourseWorkPatch -> String

showList :: [CoursesCourseWorkPatch] -> ShowS

Generic CoursesCourseWorkPatch

Associated Types

type Rep CoursesCourseWorkPatch :: * -> *

Methods

from :: CoursesCourseWorkPatch -> Rep CoursesCourseWorkPatch x

to :: Rep CoursesCourseWorkPatch x -> CoursesCourseWorkPatch

GoogleRequest CoursesCourseWorkPatch

Associated Types

type Rs CoursesCourseWorkPatch :: *

type Scopes CoursesCourseWorkPatch :: [Symbol]

Methods

requestClient :: CoursesCourseWorkPatch -> Client (Rs CoursesCourseWorkPatch)

type Rep CoursesCourseWorkPatch

type Rep CoursesCourseWorkPatch = D1 (MetaData "CoursesCourseWorkPatch" "Network.Google.Resource.Classroom.Courses.CourseWork.Patch" "gogol-classroom-0.3.0-Euho0DOVp7IFBMFcN4kr1b" False) (C1 (MetaCons "CoursesCourseWorkPatch'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccwpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_ccwpCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccwpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 CourseWork)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwpId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ccwpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes CoursesCourseWorkPatch

type Scopes CoursesCourseWorkPatch = (:) Symbol "https://www.googleapis.com/auth/classroom.coursework.students" ([] Symbol)

type Rs CoursesCourseWorkPatch

type Rs CoursesCourseWorkPatch = CourseWork

Request Lenses

ccwpXgafv :: Lens' CoursesCourseWorkPatch (Maybe Text)

V1 error format.

ccwpUploadProtocol :: Lens' CoursesCourseWorkPatch (Maybe Text)

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

ccwpUpdateMask :: Lens' CoursesCourseWorkPatch (Maybe Text)

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

ccwpPp :: Lens' CoursesCourseWorkPatch Bool

Pretty-print response.

ccwpCourseId :: Lens' CoursesCourseWorkPatch Text

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

ccwpAccessToken :: Lens' CoursesCourseWorkPatch (Maybe Text)

OAuth access token.

ccwpUploadType :: Lens' CoursesCourseWorkPatch (Maybe Text)

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

ccwpPayload :: Lens' CoursesCourseWorkPatch CourseWork

Multipart request metadata.

ccwpBearerToken :: Lens' CoursesCourseWorkPatch (Maybe Text)

OAuth bearer token.

ccwpId :: Lens' CoursesCourseWorkPatch Text

Identifier of the course work.

ccwpCallback :: Lens' CoursesCourseWorkPatch (Maybe Text)

JSONP