Перечисление учебных заведений
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение списка учебных заведений для этого пользователя.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | EduRoster.ReadBasic | Недоступно. |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | EduRoster.Read.All | EduRoster.ReadWrite.All |
Примечание.
При использовании делегированных разрешений возвращаются только ресурсы educationSchool, участником которых является пользователь проверки подлинности.
HTTP-запрос
GET /education/me/schools
GET /education/users/{id}/schools
Необязательные параметры запросов
Этот метод поддерживает параметры запросов OData для настройки ответа.
Заголовки запросов
Заголовок | Значение |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
При успешном выполнении этот метод возвращает код отклика 200 OK
и коллекцию объектов educationSchool в теле отклика.
Пример
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/education/me/schools
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "10001",
"displayName": "Contoso High School",
"description": "Public 9-12 high school",
"status": "active",
"externalSource": "sis",
"principalEmail": "amyr@contoso.com",
"principalName": "Amy Roebuck",
"externalPrincipalId": "14007",
"highestGrade": "12",
"lowestGrade": "9",
"schoolNumber": "10001",
"address": {
"city": "Los Angeles",
"countryOrRegion": "United States",
"postalCode": "98055",
"state": "CA",
"street": "12345 Main St."
},
"createdBy": {
"user": {
"displayName": "Susana Rocha",
"id": "14012",
}
},
"externalId": "10001",
"phone": "+1 (253) 555-0102",
}
]
}