- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Retorna uma lista de convites para os responsáveis que o usuário solicitante tem permissão para ver, filtrados pelos parâmetros fornecidos.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED
: se umstudentId
for especificado, e o usuário solicitante não tiver permissão para ver os convites para os responsáveis desse estudante, se"-"
for especificado comostudentId
e o usuário não for um administrador do domínio, se os responsáveis não estiverem ativados para o domínio em questão ou se houver outros erros de acesso.INVALID_ARGUMENT
se umstudentId
for especificado, mas o formato não puder ser reconhecido (não é um endereço de e-mail, umstudentId
da API nem a string literalme
). Também pode ser retornado se umpageToken
oustate
inválido for fornecido.NOT_FOUND
se umstudentId
for especificado e o formato puder ser reconhecido, mas o Google Sala de Aula não tiver um registro desse estudante.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
studentId |
O documento de identificação do estudante com os convites para os responsáveis que serão devolvidos. O identificador pode ser um dos seguintes:
|
Parâmetros de consulta
Parâmetros | |
---|---|
invitedEmailAddress |
Se especificado, apenas os resultados com o |
states[] |
Se especificado, apenas os resultados com os valores |
pageToken |
Valor A solicitação |
pageSize |
Número máximo de itens a serem devolvidos. Zero ou não especificado indica que o servidor pode atribuir um máximo. O servidor pode retornar menos do que o número especificado de resultados. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta ao listar convites para responsáveis.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"guardianInvitations": [
{
object ( |
Campos | |
---|---|
guardianInvitations[] |
Convites para responsáveis que correspondem à solicitação da lista. |
nextPageToken |
Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não haverá mais resultados disponíveis. |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Para mais informações, consulte o Guia de autorização.