Method: userProfiles.guardianInvitations.patch

Modifica la invitación de un tutor.

Actualmente, la única modificación válida es cambiar la state de PENDING a COMPLETE. De esta manera, 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 los tutores no están habilitados para el dominio en cuestión o a causa de otros errores de acceso
  • FAILED_PRECONDITION si el vínculo para tutores no está en el estado PENDING
  • INVALID_ARGUMENT si no se puede reconocer el formato del ID de estudiante proporcionado (no es una dirección de correo electrónico ni una userId de esta API), si el GuardianInvitation que se pasó tiene un state que no sea COMPLETE o si modifica campos que no sean state.
  • NOT_FOUND si el ID que proporcionaste es una ID de estudiante válida, pero Classroom no tiene registro de ese alumno o si el campo id no hace referencia a una invitación de tutor conocida por 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

Es el ID del alumno cuya invitación para tutores se modificará.

invitationId

string

El campo id del GuardianInvitation que se modificará.

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Máscara que identifica los campos del curso que 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 configura en un parámetro de consulta, este campo debe especificarse como

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

Esta es una lista separada por comas de los nombres completamente calificados de los campos. 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 descripción general de OAuth 2.0.