Method: invitations.get

Retorna um convite.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para acessar o convite solicitado ou por erros de acesso.
  • NOT_FOUND se não houver um convite com o ID solicitado.

Solicitação HTTP

GET https://classroom.googleapis.com/v1/invitations/{id}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
id

string

Identificador do convite para retorno.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Invitation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Para mais informações, consulte o guia de autorização.