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 de secciones

Se aplica a: Office 365 Educación

Esta documentación incluye las características que se encuentran actualmente en la versión de vista previa.

Las API de Office 365 para Educación ayudan a extraer datos de tu cuenta empresarial de Office 365, la cual se ha sincronizados en la nube con Microsoft School Data Sync. Estos resultados contienen información sobre escuelas, secciones, docentes, estudiantes y listas de participantes. Cada clase de la escuela está representada como una Sección. La API de REST de secciones proporciona acceso a las entidades de sección en las cuentas empresariales de Office 365 para Educación.

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

Para acceder a la API de REST para secciones desde tu aplicación, necesitarásregistrarte en Azure Active Directory. También necesitas administrar tokens de autenticación, así como generar la URL y las consultas correctas para satisfacer tus necesidades. Los siguientes ejemplos se pueden usar para ayudarte en la elaboración de sus consultas.

Todas las operaciones de la API de REST para Secciones

Las secciones se muestran como Grupos unificados en Azure Active Directory. Puedes obtener las secciones que están disponibles en una cuenta empresarial, los estudiantes y profesores que forman parte de cada sección, y los detalles de la escuela a la que pertenece una sección.

Obtener secciones | Obtener la escuela de una sección | Obtener estudiantes dentro de una sección | Obtener maestros dentro de una sección

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.

Utilizar la API de REST de secciones

Para interactuar con la API de REST de Secciones, debes enviar solicitudes HTTP GET.

Todas las solicitudes de la REST API de Secciones utilizan la siguiente URL raíz:

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

Las secciones se muestran en Azure Active Directory comoGrupos unificados. Los atributos de extensión en los grupos unificados agregan información específica sobre la educación.
Por ejemplo, el atributo extension_fe2174665583431c953114ff7268b7b3_Education_CourseNumber contiene el número de curso de una sección.

Atributos de la sección

La descripción de los atributos que ayudan a identificar la información sobre la Sección se encuentran en: Atributos de sección


Obtener secciones

Puedes obtener todas las secciones, obtener una sola sección por su id u obtener una colección de secciones que coincidan con un conjunto de criterios de consulta.

Obtener todas las secciones

Obtener todas las secciones que existen en el Azure Active Directory de la cuenta empresarial.

GET https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'

Tipo de respuesta

Una colección de entidades de sección.


Obtener una sección

Obtener una sección utilizando el id.

GET https://graph.microsoft.com/beta/groups/{id}
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
idcadenaEl identificador del grupo de sección en Azure Active Directory.

Tipo de respuesta

La entidad de sección solicitada.


Obtener la escuela de una sección

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

Puedes obtener la escuela a la que está asociada una sección consultando las unidades administrativas en función de la propiedad SchoolId obtenida de extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId como respuesta de Obtener una sección.

GET https://graph.microsoft.com/administrativeUnits?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'%20
and%20extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId%20eq%20{school_id}
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
school_idcadenaEl identificador de la escuela en el Sistema de información escolar (SIS).

Tipo de respuesta

Una entidad de escuela.


Obtener estudiantes dentro de una sección

Los estudiantes se muestran en Azure Active Directory como usuarios. Los atributos de extensión de usuario agregan información específica del estudiante. Por ejemplo, el atributo extension_fe2174665583431c953114ff7268b7b3_Education_Grade contiene el curso del estudiante.

Puedes obtener estudiantes de una sección específica obteniendo los miembros del grupo unificado de la sección y filtrar a los usuarios que no son estudiantes de la colección resultante desde tu aplicación.

Obtener miembros de la sección

GET https://graph.microsoft.com/beta/groups/{id}/members
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
idcadenaEl identificador del grupo de sección en Azure Active Directory.

Tipo de respuesta

Una colección de usuarios.

Buscar estudiantes

Una colección de usuarios puede contener estudiantes, profesores y usuarios no docentes (por ejemplo, personal administrativo). Puedes filtrar una colección seleccionado solo estudiantes desde tu aplicación. Consultar para que el atributo de extensión Education_ObjectType sea igual a Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

Obtener maestros dentro de una sección

Los profesores se muestran en Azure Active Directory como usuarios. Los atributos de extensión de usuario agregan información específica del profesor. Por ejemplo, el atributo extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber contiene el número de profesor del profesor.

Puedes filtrar profesores de una sección específica obteniendo los miembros del grupo unificado de la sección y, posteriormente, volver a filtrar los usuarios que no son profesores de la colección resultante desde tu aplicación.

Obtener miembros de la sección

GET https://graph.microsoft.com/beta/groups/{id}/members
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
tenant_idcadenaEl identificador de la cuenta empresarial de Azure Active Directory o el nombre de dominio.
idcadenaEl identificador del grupo de sección en Azure Active Directory.

Tipo de respuesta

Una colección de usuarios.

Buscar profesores

Una colección de usuarios puede contener estudiantes, profesores y usuarios no docentes (por ejemplo, personal administrativo). Puedes filtrar la colección indicando solo profesores desde tu aplicación. Consultar para que el atributo de extensión Education_ObjectType sea igual a Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'

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