Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 25/07/2018

Referencia de la API de REST para estudiantes

Se aplica a: Office 365 Educación

Esta documentación cubre las características que se encuentran actualmente en la versión preliminar.

Las API Office 365 Education ayudan a extraer datos de su Office 365 de inquilinos, los cuales han sido sincronizados en la nube con Microsoft School Data Sync. Estos resultados contienen información sobre escuelas, secciones, docentes, estudiantes e información de registro. La REST API para estudiantes proporciona acceso a entidades estudiantiles en una Office 365 for Education de inquilinos.

La API depende de Microsoft Azure Active Directory y OAuth para autenticar solicitudes de aplicaciones.

Para acceder a la REST API de estudiantes desde su aplicación, necesitaráregistrarse en Azure Active Directory. También necesita gestionar señales de autenticación, así como desarrollar la URL correcta y las consultas para satisfacer sus necesidades. Los siguientes ejemplos se pueden usar para ayudar en la elaboración de tus consultas.

Probar las API

Todas las API de listas de participante de escuelas pueden probarse en una cuenta empresarial EDU usando el Probador de Graph. Navega en el Probador de Graph, inicia sesión con tus credenciales de cuenta empresarial O365 EDU, selecciona 'beta' como versión, copia/pega las URL y verifica la respuesta.

Todas las operaciones REST API para estudiantes

Los estudiantes se presentan como usuarios en Azure Active Directory. Usted podrá obtener información sobre el estudiante actualmente conectado, y también obtener la escuela y secciones de las que forma parte ese alumno.

Obtener usuario actual | Obtener la escuela de un estudiante | Obtener la sección de un estudiante

Usar la API de REST para estudiantes

Para interactuar con la REST API para estudiantes, debe enviar solicitudes HTTP GET.

Si el usuario que inició sesión es un estudiante, entonces todas las solicitudes de REST API para estudiantes utilizan la siguiente URL raíz:

https://graph.microsoft.com/beta/me/

Los estudiantes serán presentados en Azure Active Directory como usuarios. Los atributos de extensión de los usuarios añaden información específica del alumno.
Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_Grade atributo contiene las calificaciones del estudiante.

Atributos del estudiante

La descripción de los atributos que ayudan a identificar la información sobre el estudiante se encuentra en: Atributos del estudiante


Obtener el usuario actual

Puede acceder al usuario actualmente conectado y comprobar si ese usuario es un estudiante.

GET https://graph.microsoft.com/beta/me/

Tipo de respuesta

El usuario registrado actualmente.

Verificar si es estudiante

Un usuario actualmente registrado puede ser un estudiante, docente o usuario no educativo (por ejemplo, personal administrativo). Puede verificar si el usuario es un estudiante desde su aplicación. Consultar por Education_ObjectType atributo de extensión igual a Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

Obtener la escuela de un estudiante

Las escuelas se representan en Azure Active Directory como Unidades administrativas. Los atributos de extensión en estas unidades administrativas agregan información específica sobre la escuela. Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade atributo contiene la calificación más alta para esa escuela.

Puede acceder a la escuela del estudiante, obteniendo la membresía de ese estudiante y, tras ello, filtrando por extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School' y objectType == 'AdministrativeUnit'

Obtener la membresía del estudiante

Puede obtener la membresía del estudiante conectado utilizando la siguiente consulta.

GET https://graph.microsoft.com/beta/me/

Tipo de respuesta

La respuesta incluirá múltiples Grupos, DirectoriosFunciones y/o UnidadesAdministrativas de los que el alumno es socio.

Filtrar por escuela

Puede obtener la escuela de un alumno filtrando en extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School' y objectType == 'AdministrativeUnit'.


Obtener la sección de un estudiante

Las secciones se representan en Azure Active Directory comoGrupos unificados. Los atributos de extensión en los grupos unificados agregan información específica sobre la sección. Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_CourseName atributo contiene el nombre del curso para la sección.

Obtener la membresía del estudiante

Puede obtener la membresía del estudiante conectado utilizando la siguiente consulta.

GET https://graph.microsoft.com/beta/me/

Tipo de respuesta

La respuesta incluirá múltiples Grupos, DirectoriosFunciones y/o UnidadesAdministrativas de los que el alumno es socio.

Filtrar por Sección

Puede obtener la sección de un estudiante filtrando por extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Section' y objectType == 'Group'.


Pasos siguientes

Otros recursos educativos similares en los que podrías estar interesado

Tanto si ya estás preparado para comenzar a desarrollar una aplicación o si tan solo deseas obtener más información, tenemos todo lo que necesitas.

O bien, obtén más información sobre el uso de la plataforma Office 365:

© 2018 Microsoft