| Copyright | (c) 2015-2025 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <[email protected]> Toni Cebrián <[email protected]> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | GHC2021 |
Gogol.Classroom.UserProfiles.GuardianInvitations.Get
Contents
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 ClassroomUserProfilesGuardianInvitationsGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (Capture "invitationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GuardianInvitation))))))))))
- data ClassroomUserProfilesGuardianInvitationsGet = ClassroomUserProfilesGuardianInvitationsGet {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- invitationId :: Text
- studentId :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
- newClassroomUserProfilesGuardianInvitationsGet :: Text -> Text -> ClassroomUserProfilesGuardianInvitationsGet
Resource
type ClassroomUserProfilesGuardianInvitationsGetResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (Capture "invitationId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GuardianInvitation)))))))))) Source #
A resource alias for classroom.userProfiles.guardianInvitations.get method which the
ClassroomUserProfilesGuardianInvitationsGet request conforms to.
Constructing a Request
data ClassroomUserProfilesGuardianInvitationsGet 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: newClassroomUserProfilesGuardianInvitationsGet smart constructor.
Constructors
| ClassroomUserProfilesGuardianInvitationsGet | |
Fields
| |
Instances
newClassroomUserProfilesGuardianInvitationsGet Source #
Arguments
| :: Text | The |
| -> Text | The ID of the student whose guardian invitation is being requested. See |
| -> ClassroomUserProfilesGuardianInvitationsGet |
Creates a value of ClassroomUserProfilesGuardianInvitationsGet with the minimum fields required to make a request.