Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get

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.

REST Resource

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

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

Creating a Request

userProFilesGuardianInvitationsGet

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:

• upfgigStudentId
• upfgigXgafv
• upfgigUploadProtocol
• upfgigPp
• upfgigAccessToken
• upfgigUploadType
• upfgigInvitationId
• upfgigBearerToken
• upfgigCallback

data UserProFilesGuardianInvitationsGet

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

Methods

(==) :: UserProFilesGuardianInvitationsGet -> UserProFilesGuardianInvitationsGet -> Bool

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

Data UserProFilesGuardianInvitationsGet

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

Methods

showsPrec :: Int -> UserProFilesGuardianInvitationsGet -> ShowS

show :: UserProFilesGuardianInvitationsGet -> String

showList :: [UserProFilesGuardianInvitationsGet] -> ShowS

Generic UserProFilesGuardianInvitationsGet

Associated Types

type Rep UserProFilesGuardianInvitationsGet :: * -> *

Methods

from :: UserProFilesGuardianInvitationsGet -> Rep UserProFilesGuardianInvitationsGet x

to :: Rep UserProFilesGuardianInvitationsGet x -> UserProFilesGuardianInvitationsGet

GoogleRequest UserProFilesGuardianInvitationsGet

Associated Types

type Rs UserProFilesGuardianInvitationsGet :: *

type Scopes UserProFilesGuardianInvitationsGet :: [Symbol]

Methods

requestClient :: UserProFilesGuardianInvitationsGet -> Client (Rs UserProFilesGuardianInvitationsGet)

type Rep UserProFilesGuardianInvitationsGet

type Rep UserProFilesGuardianInvitationsGet = D1 (MetaData "UserProFilesGuardianInvitationsGet" "Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.Get" "gogol-classroom-0.3.0-Euho0DOVp7IFBMFcN4kr1b" False) (C1 (MetaCons "UserProFilesGuardianInvitationsGet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfgigStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_upfgigXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upfgigUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgigPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfgigAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgigUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upfgigInvitationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_upfgigBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfgigCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes UserProFilesGuardianInvitationsGet

type Scopes UserProFilesGuardianInvitationsGet = [] Symbol

type Rs UserProFilesGuardianInvitationsGet

type Rs UserProFilesGuardianInvitationsGet = GuardianInvitation

Request Lenses

upfgigStudentId :: Lens' UserProFilesGuardianInvitationsGet Text

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

upfgigXgafv :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

V1 error format.

upfgigUploadProtocol :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

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

upfgigPp :: Lens' UserProFilesGuardianInvitationsGet Bool

Pretty-print response.

upfgigAccessToken :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

OAuth access token.

upfgigUploadType :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

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

upfgigInvitationId :: Lens' UserProFilesGuardianInvitationsGet Text

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

upfgigBearerToken :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

OAuth bearer token.

upfgigCallback :: Lens' UserProFilesGuardianInvitationsGet (Maybe Text)

JSONP