Method: userProfiles.guardianInvitations.patch

Modifica una invitación para tutores.

Por el momento, la única modificación válida es cambiar state de PENDING a COMPLETE. Como resultado, se retira la invitación.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED si el usuario actual no tiene permiso para administrar a los tutores, si estos no están habilitados para el dominio en cuestión o si hay otros errores de acceso.
  • FAILED_PRECONDITION si el vínculo al tutor no está en el estado PENDING.
  • INVALID_ARGUMENT si no se puede reconocer el formato del ID de alumno proporcionado (no es una dirección de correo electrónico ni una userId de esta API), si el GuardianInvitation pasado tiene un state distinto de COMPLETE, o bien si modifica campos que no sean state
  • NOT_FOUND si la ID de estudiante proporcionada es válida, pero Classroom no tiene registro de ese estudiante, o si el campo id no hace referencia a una invitación para tutores que se conoce a Classroom.

Solicitud HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
studentId

string

El ID del estudiante cuya invitación se va a modificar como tutor
invitationId

string

El campo id de GuardianInvitation que se modificará.

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Máscara que identifica qué campos del curso se deben actualizar. Este campo es obligatorio para realizar una actualización. La actualización falla si se especifican campos no válidos. Los siguientes campos son válidos:

  • state

Cuando se establece en un parámetro de consulta, este campo se debe especificar como

updateMask=<field1>,<field2>,...

Esta es una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud incluye una instancia de GuardianInvitation.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de GuardianInvitation.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Para obtener más información, consulta la guía de autorización.