Network.Google.Resource.Classroom.UserProFiles.Guardians.List

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

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

REST Resource

type UserProFilesGuardiansListResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardians" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "invitedEmailAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListGuardiansResponse))))))))))))))

A resource alias for classroom.userProfiles.guardians.list method which the UserProFilesGuardiansList request conforms to.

Creating a Request

userProFilesGuardiansList

Arguments

:: Text

upfglStudentId

-> UserProFilesGuardiansList

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

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

• upfglStudentId
• upfglXgafv
• upfglUploadProtocol
• upfglPp
• upfglAccessToken
• upfglUploadType
• upfglBearerToken
• upfglInvitedEmailAddress
• upfglPageToken
• upfglPageSize
• upfglCallback

data UserProFilesGuardiansList

Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

See: userProFilesGuardiansList smart constructor.

Instances

Eq UserProFilesGuardiansList

Methods

(==) :: UserProFilesGuardiansList -> UserProFilesGuardiansList -> Bool

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

Data UserProFilesGuardiansList

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserProFilesGuardiansList -> c UserProFilesGuardiansList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserProFilesGuardiansList

toConstr :: UserProFilesGuardiansList -> Constr

dataTypeOf :: UserProFilesGuardiansList -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UserProFilesGuardiansList)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserProFilesGuardiansList)

gmapT :: (forall b. Data b => b -> b) -> UserProFilesGuardiansList -> UserProFilesGuardiansList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserProFilesGuardiansList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserProFilesGuardiansList -> r

gmapQ :: (forall d. Data d => d -> u) -> UserProFilesGuardiansList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UserProFilesGuardiansList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserProFilesGuardiansList -> m UserProFilesGuardiansList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProFilesGuardiansList -> m UserProFilesGuardiansList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProFilesGuardiansList -> m UserProFilesGuardiansList

Show UserProFilesGuardiansList

Methods

showsPrec :: Int -> UserProFilesGuardiansList -> ShowS

show :: UserProFilesGuardiansList -> String

showList :: [UserProFilesGuardiansList] -> ShowS

Generic UserProFilesGuardiansList

Associated Types

type Rep UserProFilesGuardiansList :: * -> *

Methods

from :: UserProFilesGuardiansList -> Rep UserProFilesGuardiansList x

to :: Rep UserProFilesGuardiansList x -> UserProFilesGuardiansList

GoogleRequest UserProFilesGuardiansList

Associated Types

type Rs UserProFilesGuardiansList :: *

type Scopes UserProFilesGuardiansList :: [Symbol]

Methods

requestClient :: UserProFilesGuardiansList -> Client (Rs UserProFilesGuardiansList)

type Rep UserProFilesGuardiansList

type Rep UserProFilesGuardiansList = D1 (MetaData "UserProFilesGuardiansList" "Network.Google.Resource.Classroom.UserProFiles.Guardians.List" "gogol-classroom-0.3.0-Euho0DOVp7IFBMFcN4kr1b" False) (C1 (MetaCons "UserProFilesGuardiansList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfglStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_upfglXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upfglUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_upfglPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_upfglAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upfglUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_upfglBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upfglInvitedEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_upfglPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_upfglPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_upfglCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes UserProFilesGuardiansList

type Scopes UserProFilesGuardiansList = [] Symbol

type Rs UserProFilesGuardiansList

type Rs UserProFilesGuardiansList = ListGuardiansResponse

Request Lenses

upfglStudentId :: Lens' UserProFilesGuardiansList Text

Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.

upfglXgafv :: Lens' UserProFilesGuardiansList (Maybe Text)

V1 error format.

upfglUploadProtocol :: Lens' UserProFilesGuardiansList (Maybe Text)

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

upfglPp :: Lens' UserProFilesGuardiansList Bool

Pretty-print response.

upfglAccessToken :: Lens' UserProFilesGuardiansList (Maybe Text)

OAuth access token.

upfglUploadType :: Lens' UserProFilesGuardiansList (Maybe Text)

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

upfglBearerToken :: Lens' UserProFilesGuardiansList (Maybe Text)

OAuth bearer token.

upfglInvitedEmailAddress :: Lens' UserProFilesGuardiansList (Maybe Text)

Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.

upfglPageToken :: Lens' UserProFilesGuardiansList (Maybe Text)

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

upfglPageSize :: Lens' UserProFilesGuardiansList (Maybe Int32)

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

upfglCallback :: Lens' UserProFilesGuardiansList (Maybe Text)

JSONP