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.Guardians.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information 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 the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.

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

Synopsis

type UserProFilesGuardiansGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardians" :> (Capture "guardianId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Guardian))))))))))
userProFilesGuardiansGet :: Text -> Text -> UserProFilesGuardiansGet
data UserProFilesGuardiansGet
upfggStudentId :: Lens' UserProFilesGuardiansGet Text
upfggXgafv :: Lens' UserProFilesGuardiansGet (Maybe Xgafv)
upfggUploadProtocol :: Lens' UserProFilesGuardiansGet (Maybe Text)
upfggAccessToken :: Lens' UserProFilesGuardiansGet (Maybe Text)
upfggUploadType :: Lens' UserProFilesGuardiansGet (Maybe Text)
upfggGuardianId :: Lens' UserProFilesGuardiansGet Text
upfggCallback :: Lens' UserProFilesGuardiansGet (Maybe Text)

REST Resource

type UserProFilesGuardiansGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardians" :> (Capture "guardianId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Guardian)))))))))) Source #

A resource alias for classroom.userProfiles.guardians.get method which the UserProFilesGuardiansGet request conforms to.

Creating a Request

userProFilesGuardiansGet Source #

Arguments

:: Text	`upfggStudentId`
-> Text	`upfggGuardianId`
-> UserProFilesGuardiansGet

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

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

data UserProFilesGuardiansGet Source #

Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information 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 the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.

See: userProFilesGuardiansGet smart constructor.

Instances

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

Request Lenses

upfggStudentId :: Lens' UserProFilesGuardiansGet Text Source #

The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

upfggXgafv :: Lens' UserProFilesGuardiansGet (Maybe Xgafv) Source #

V1 error format.

upfggUploadProtocol :: Lens' UserProFilesGuardiansGet (Maybe Text) Source #

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

upfggAccessToken :: Lens' UserProFilesGuardiansGet (Maybe Text) Source #

OAuth access token.

upfggUploadType :: Lens' UserProFilesGuardiansGet (Maybe Text) Source #

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

upfggGuardianId :: Lens' UserProFilesGuardiansGet Text Source #

The `id` field from a `Guardian`.

upfggCallback :: Lens' UserProFilesGuardiansGet (Maybe Text) Source #

JSONP