gogol-classroom-0.0.1: Google Classroom SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Invitations.List

Contents

Description

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

See: Google Classroom API Reference for classroom.invitations.list.

Synopsis

REST Resource

type InvitationsListResource = "v1" :> ("invitations" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "courseId" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListInvitationsResponse))))))))))))) Source

A resource alias for classroom.invitations.list method which the InvitationsList request conforms to.

Creating a Request

invitationsList :: InvitationsList Source

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

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

data InvitationsList Source

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

See: invitationsList smart constructor.

Instances

Request Lenses

ilXgafv :: Lens' InvitationsList (Maybe Text) Source

V1 error format.

ilUploadProtocol :: Lens' InvitationsList (Maybe Text) Source

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

ilPp :: Lens' InvitationsList Bool Source

Pretty-print response.

ilCourseId :: Lens' InvitationsList (Maybe Text) Source

Restricts returned invitations to those for a course with the specified identifier.

ilAccessToken :: Lens' InvitationsList (Maybe Text) Source

OAuth access token.

ilUploadType :: Lens' InvitationsList (Maybe Text) Source

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

ilUserId :: Lens' InvitationsList (Maybe Text) Source

Restricts returned invitations to those for a specific user. 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

ilBearerToken :: Lens' InvitationsList (Maybe Text) Source

OAuth bearer token.

ilPageToken :: Lens' InvitationsList (Maybe Text) Source

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.

ilPageSize :: Lens' InvitationsList (Maybe Int32) Source

Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

ilCallback :: Lens' InvitationsList (Maybe Text) Source

JSONP