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

Referencia de API de REST para escuelas

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 conMicrosoft School Data Sync. Estos resultados contienen información sobre escuelas, secciones, docentes, estudiantes y registro. La API REST para escuelas proporciona acceso a entidades escolares en Office 365 Education de inquilinos.

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

Para acceder a la REST API para escuelas 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 sus consultas.

Todas las operaciones de la API REST para escuelas

Las escuelas están representadas como Unidades administrativas en Azure Active Directory. Puede obtener las escuelas que están disponibles en un inquilino y también obtener las secciones, los estudiantes y los docentes que forman parte de cada entidad escolar.

Obtener escuelas | Obtener secciones de una escuela | Obtener estudiantes de una escuela | Obtener docentes de una escuela

Probando 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 para escuelas

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

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

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

Las escuelas se representan en el Azure Active Directory como unidades administrativas. Los atributos de extensión en las unidades administrativas añaden información específica sobre educación.
Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade atributo contiene la clasificación más alta en la escuela.

Nota Todas las solicitudes deben especificar 'beta' en la URL.

Atributos de la escuela

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


Obtener escuelas

Puede obtener todas las escuelas, obtener una sola escuela a través de su idu obtener un grupo de escuelas que coincidan con un conjunto de filtros de consulta.

Obtener todas las escuelas

Obtener todas las escuelas que existen en el Azure Active Directory de inquilinos.

https://graph.microsoft.com/beta/administrativeUnits/?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'

Tipo de respuesta

Un grupo de entidades escolares.


Obtener una escuela

Obtener una sola escuela usando el id.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
idcadenaEl ID de la unidad administrativa de la escuela en Azure Active Directory.

Tipo de respuesta

La entidad escolar solicitada.


Obtenga las secciones de una escuela

Las secciones se representan en Azure Active Directory comoGrupos unificados. Los atributos de extensión en los grupos unificados añaden 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.

Puede obtener secciones relacionadas con una escuela específica preguntando por grupos según el ID de escuela, usando el extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType atributo y el extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId atributo conjuntamente en la consulta.

GET  https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'%20and%20extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId%20eq%20'10002'
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
school_idcadenaLa identificación de la escuela en el Sistema de información escolar (SIS), resultado de obtener escuelas

Tipo de respuesta

Una colección de entidades de sección.


Obtener estudiantes de una escuela

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 sobre el alumno. Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_Grade atributo contiene la clasificación del estudiante.

Puede acceder a estudiantes en una escuela específica, al obtener los miembros de la unidad administrativa de la escuela y filtrar a los usuarios no estudiantes del grupo resultante desde su aplicación.

Obtener escuelas asociadas

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
idcadenaEl ID de la unidad administrativa de la escuela en Azure Active Directory.

Tipo de respuesta

Una colección de usuarios.

Buscar estudiantes

Un grupo de usuarios puede contener estudiantes, docentes y usuarios no educativos (por ejemplo, personal administrativo). Puede filtrar el grupo seleccionado por estudiantes desde su aplicación. Buscar el Education_ObjectType atributo de extensión a igual Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Student'

Obtener docentes de una escuela

Los docentes serán presentados en Azure Active Directory como usuarios. Los docentes se representan en Azure Active Directory como usuarios. Por ejemplo, el extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber atributo contiene el número de profesor del docente.

Puede acceder a docentes de una escuela específica, al obtener los miembros de la unidad administrativa de la escuela y filtrar a los usuarios no docentes del grupo resultante desde su aplicación.

Obtener escuelas asociadas

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Parámetro obligatorioTipoDescripción
Parámetros de dirección URL
idcadenaEl ID de la unidad administrativa de la escuela en Azure Active Directory.

Tipo de respuesta

Una colección de usuarios.

Buscar profesores

Un grupo de usuarios puede contener estudiantes, docentes y usuarios no educativos (por ejemplo, personal administrativo). Puede filtrar el grupo seleccionado por docentes desde su aplicación. Busque el Education_ObjectType atributo de extensión a igual Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Teacher'

Pasos siguientes

Otros recursos relacionados con la educación en los que podría 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