REST Resource: userProfiles.guardianInvitations

Recurso: GuardianInvitation

Una invitación para ser el tutor de un usuario específico, que se envía a una dirección de correo electrónico determinada.

Representación JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Campos
studentId

string

ID del estudiante (en formato estándar)
invitationId

string

Es el identificador único de esta invitación.

Solo lectura.
invitedEmailAddress

string

Dirección de correo electrónico a la que se envió la invitación. Este campo solo es visible para los administradores de dominio.
state

enum (GuardianInvitationState)

Estado en el que se encuentra esta invitación.
creationTime

string (Timestamp format)

La hora a la que se creó esta invitación.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Estado de la invitación para un tutor.

Enumeraciones
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nunca se debe mostrar.
PENDING La invitación se encuentra activa y a la espera de una respuesta.
COMPLETE La invitación ya no está activa. Es posible que se haya aceptado, rechazado o retirado, o que haya vencido.

Métodos

create

 Crea una invitación para ser tutor y le envía un correo electrónico a este pidiéndole que confirme que es el tutor del estudiante.

get

 Muestra una invitación para un tutor específico.

list

 Devuelve una lista de invitaciones a tutores que el usuario solicitante tiene permitido ver, filtradas según los parámetros proporcionados.

patch

 Modifica una invitación para un tutor.