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.UserProFiles.GuardianInvitations.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.

See: Google Classroom API Reference for classroom.userProfiles.guardianInvitations.get.

Synopsis

type UserProFilesGuardianInvitationsGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (Capture "invitationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GuardianInvitation))))))))))
userProFilesGuardianInvitationsGet :: Text -> Text -> UserProFilesGuardianInvitationsGet
data UserProFilesGuardianInvitationsGet
upfgigStudentId :: Lens' UserProFilesGuardianInvitationsGet Text
upfgigXgafv :: Lens' UserProFilesGuardianInvitationsGet (Maybe Xgafv)
upfgigUploadProtocol :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)
upfgigAccessToken :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)
upfgigUploadType :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)
upfgigInvitationId :: Lens' UserProFilesGuardianInvitationsGet Text
upfgigCallback :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

REST Resource

type UserProFilesGuardianInvitationsGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (Capture "invitationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GuardianInvitation)))))))))) Source #

A resource alias for classroom.userProfiles.guardianInvitations.get method which the UserProFilesGuardianInvitationsGet request conforms to.

Creating a Request

userProFilesGuardianInvitationsGet Source #

Arguments

:: Text	`upfgigStudentId`
-> Text	`upfgigInvitationId`
-> UserProFilesGuardianInvitationsGet

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

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

data UserProFilesGuardianInvitationsGet Source #

Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.

See: userProFilesGuardianInvitationsGet smart constructor.

Instances

Eq UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get Methods (==) :: UserProFilesGuardianInvitationsGet -> UserProFilesGuardianInvitationsGet -> Bool # (/=) :: UserProFilesGuardianInvitationsGet -> UserProFilesGuardianInvitationsGet -> Bool #
Data UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserProFilesGuardianInvitationsGet -> c UserProFilesGuardianInvitationsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserProFilesGuardianInvitationsGet # toConstr :: UserProFilesGuardianInvitationsGet -> Constr # dataTypeOf :: UserProFilesGuardianInvitationsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserProFilesGuardianInvitationsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserProFilesGuardianInvitationsGet) # gmapT :: (forall b. Data b => b -> b) -> UserProFilesGuardianInvitationsGet -> UserProFilesGuardianInvitationsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserProFilesGuardianInvitationsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserProFilesGuardianInvitationsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> UserProFilesGuardianInvitationsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserProFilesGuardianInvitationsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserProFilesGuardianInvitationsGet -> m UserProFilesGuardianInvitationsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProFilesGuardianInvitationsGet -> m UserProFilesGuardianInvitationsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProFilesGuardianInvitationsGet -> m UserProFilesGuardianInvitationsGet #
Show UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get Methods showsPrec :: Int -> UserProFilesGuardianInvitationsGet -> ShowS # show :: UserProFilesGuardianInvitationsGet -> String # showList :: [UserProFilesGuardianInvitationsGet] -> ShowS #
Generic UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get Associated Types type Rep UserProFilesGuardianInvitationsGet :: Type -> Type # Methods from :: UserProFilesGuardianInvitationsGet -> Rep UserProFilesGuardianInvitationsGet x # to :: Rep UserProFilesGuardianInvitationsGet x -> UserProFilesGuardianInvitationsGet #
GoogleRequest UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get Associated Types type Rs UserProFilesGuardianInvitationsGet :: Type # type Scopes UserProFilesGuardianInvitationsGet :: [Symbol] # Methods requestClient :: UserProFilesGuardianInvitationsGet -> GClient (Rs UserProFilesGuardianInvitationsGet) #
type Rep UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get type Rep UserProFilesGuardianInvitationsGet = D1 (MetaData "UserProFilesGuardianInvitationsGet" "Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "UserProFilesGuardianInvitationsGet'" PrefixI True) ((S1 (MetaSel (Just "_upfgigStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_upfgigXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_upfgigUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_upfgigAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_upfgigUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_upfgigInvitationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_upfgigCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get type Scopes UserProFilesGuardianInvitationsGet = "https://www.googleapis.com/auth/classroom.guardianlinks.students" ': ("https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ': ([] :: [Symbol]))
type Rs UserProFilesGuardianInvitationsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get type Rs UserProFilesGuardianInvitationsGet = GuardianInvitation

Request Lenses

upfgigStudentId :: Lens' UserProFilesGuardianInvitationsGet Text Source #

The ID of the student whose guardian invitation is being requested.

upfgigXgafv :: Lens' UserProFilesGuardianInvitationsGet (Maybe Xgafv) Source #

V1 error format.

upfgigUploadProtocol :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text) Source #

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

upfgigAccessToken :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text) Source #

OAuth access token.

upfgigUploadType :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text) Source #

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

upfgigInvitationId :: Lens' UserProFilesGuardianInvitationsGet Text Source #

The `id` field of the `GuardianInvitation` being requested.

upfgigCallback :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text) Source #

JSONP