From c8d65bdbb1b79707de159d67a437b9757378fb1e Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 1 Nov 2017 16:00:13 -0700 Subject: [PATCH 01/87] Edit pass in progress. --- ...{api_overview.md => education-overview.md} | 30 +++++-------------- 1 file changed, 7 insertions(+), 23 deletions(-) rename EDUGraphAPIs/{api_overview.md => education-overview.md} (64%) diff --git a/EDUGraphAPIs/api_overview.md b/EDUGraphAPIs/education-overview.md similarity index 64% rename from EDUGraphAPIs/api_overview.md rename to EDUGraphAPIs/education-overview.md index 0a45eded..0f8842c7 100644 --- a/EDUGraphAPIs/api_overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -1,25 +1,20 @@ -# Working with Edu assignments and rostering in Microsoft Graph +# Working with Education APIs in Microsoft Graph - -**Microsoft Graph Education Endpoint is available for private preview : -https://graph.microsoft.com/beta/education/** - -The **Microsoft Graph API** is a valuable tool that gives developers access to Office 365 resources through one REST endpoint and one access token. This is done by accessing the Graph through a set of URLs like the following examples: + +The Education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant to education-related scenarios, including information about schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -While these **Office 365** resources are powerful and useful inside an educational institution that uses **Office 365**, the Education endpoint in Microsoft Graph also decorates **Office 365** graph data with education related information such as students, teachers, and classes. This makes it easier for ISV Office developers to integrate with educational resources. - -In addition, the Education endpoint also introduces two new education specific resources. **Rostering** and **Assignments** make it easy to interact with the assignment and rostering services within Microsoft Teams for Education. +The Education APIs include two new resources, **Rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. -The **Microsoft graph education** namespace allows developers access to schools, students, teachers, classes, enrollments, and **Assignments**. + ## Authorization -Read about the API permissions needed for the assignment API in the Assignments API [Getting started](./Assignments/GettingStarted.md) article. The API permissions needed for the rostering API are described in the Rostering API [Getting started](./Rostering/GettingStarted.md) article. - For more information about permissions, including delegated and application permissions, see [Permissions](../../../concepts/permissions_reference.md). ## Common use cases @@ -68,17 +63,6 @@ The Rostering APIs support this by providing APIs to support the following scena - get My Schools/Classes - - - - ## Next steps Use your new understanding of the Microsoft Graph Education API to build education solutions around student assignments and school rosters. -### Getting started with assignments API -Read [Microsoft Education Graph Assignments API : Getting Started](./Assignments/GettingStarted.md) to get started with **Assignments** API including learning about Scopes, assignment Resources, APIs, Samples, and Building your first sample. - - -### Getting started with Rostering API -Read [Microsoft Education Graph Rostering API : Getting Started](./Rostering/GettingStarted.md) to get started with Rostering API including learning about Scopes, Roster Resources , APIs, Samples and Building your first sample. - From be9ca1109f995fd83e1df946b7261f7aff647f85 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 2 Nov 2017 10:27:12 -0700 Subject: [PATCH 02/87] Edits in progress. --- .../api/educationassignment_delete.md | 2 +- .../resources/educationassignment.md | 7 ++- EDUGraphAPIs/education-overview.md | 45 ++++++++----------- 3 files changed, 24 insertions(+), 30 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index bd730723..7e9dd7ec 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -13,9 +13,9 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request -```http +```http DELETE /education/classes//assignments/ ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index dc1a1490..de6a2b3b 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -4,12 +4,15 @@ most of the APIs are exposed in the class namespace. Only a teacher in a class can create an assignment. Assignment starts in the "Draft" state when created. In draft, students will not see the assignment and submissions will not be created. The status on an assignment cannot be changed via PATCH. It can only be changed using the action. + - + ## Methods | Method | Return Type |Description| diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 0f8842c7..e22eb563 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -7,46 +7,37 @@ The Microsoft Graph API provides access to Office 365 resources through one REST https://graph.microsost.com//groups https://graph.microsoft.com//me/calendars --> -The Education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant to education-related scenarios, including information about schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The Education APIs include two new resources, **Rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. +The Education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. + +The Education APIs include two new resources, **Rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. ## Authorization - -For more information about permissions, including delegated and application permissions, see [Permissions](../../../concepts/permissions_reference.md). - -## Common use cases - -The core use cases for the Microsoft Education Graph API include automating student assignments and managing a school roster. - -### Assignments APIs - -Microsoft Graph **Assignments** Resources allow partners to integrate with the **Assignments** service under the Microsoft Teams in **Office 365** for Education tab of the same name. The Public API is the same API that _Microsoft Teams in Office 365 for Education_ built it's user interface with. Thus, the best sample of what can be built with the Microsoft **Assignments** API is _Microsoft Teams in Office 365 for Education_. - -#### 'Assignments' resource description +To call the Education APIs in Microsoft Graph, your app will need the appropriate permissions. +For more information about permissions for Education APIs, see [Permissions](../../../concepts/permissions_reference.md). -An [Assignment](./Assignments/resources/educationassignmentresource.md) is a task or unit of work assigned to a student or team member in a class as part of their study. Only teachers or team owners can create assignments. Assignments contain handouts and tasks that the teacher wants the student to work on. Each student assignment has an associated [submission](./Assignments/resources/educationsubmissionresource.md) that contains any work their teacher asked to be turned in. A teacher can add scores and feedback to the submission turned in by the student. +## Assignments +You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams in Office 365 for Education. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use the assignment APIs to interact with assignments throughout the assignment lifecycle. -#### Sample scenarios -As mentioned above the **Assignments** APIs allow partners to interact with the assignment Services. Here are some sample scenarios: - -1. Create Assignment - An external system can create assignment for the class and attach resources to the assignment. - -2. Read assignment information - An analytics application can get information about assignments and student submissions including dates and grades. - -3. Dashboard to track student submissions - A Teacher dashboard that shows how many Submissions have been submitted and how many need to be graded. - -These are just a few examples. The assignment APIs provide a mechanism for external applications to interact with the life-cycle of the assignment. + +The following are some common use cases for the assignment-related Education APIs. +|Use case|Description|See also| +|:-------|:----------|:-------| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|| -### Rostering APIs +## Rostering -Rostering APIs in the **Microsoft Graph Education endpoint** are used to extract data from the school's **Office 365** tenant which has been synced to the cloud by Microsoft School Data Sync. These results provide information about schools, sections, teachers, students, and rosters. These APIs while functionally similar to the current Roster APIs, provide first class access to the roster data. The APIs provide both app-only APIs primarily for sync-centric scenarios and app+user APIs designed for interactive scenarios. The app+user APIs will enforce region-appropriate RBAC policies based on the user role calling the API. This will provide a consistent API and minimal policy surface regardless of administrative configuration within tenants. In addition, the APIs also provide EDU specific scopes to ensure the right user has access to the data. +The rostering APIs enable you to extract data from a school's Office 365 tenant provisioned with Microsoft School Data Sync. These APIs provide access to information about schools, sections, teachers, students, and rosters. The APIs provide both app-only APIs primarily for sync-centric scenarios and app+user APIs designed for interactive scenarios. The app+user APIs will enforce region-appropriate RBAC policies based on the user role calling the API. This will provide a consistent API and minimal policy surface regardless of administrative configuration within tenants. In addition, the APIs also provide EDU specific scopes to ensure the right user has access to the data. #### Rostering resources description The typical scenario for Rostering APIs to enable the user logged into a 3rd party ISV app to know: From 9128bc32d2834d996550ff5eb8db5d5d6e944871 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 2 Nov 2017 11:15:37 -0700 Subject: [PATCH 03/87] Finished initial edit pass on overview topic. --- EDUGraphAPIs/education-overview.md | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index e22eb563..8096bd07 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -21,7 +21,7 @@ For more information about permissions for Education APIs, see [Permissions](../ ## Assignments -You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams in Office 365 for Education. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use the assignment APIs to interact with assignments throughout the assignment lifecycle. +You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. From 6dbe6530ef7f59a37657da74282b3ae92c2ff6a2 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 2 Nov 2017 11:29:29 -0700 Subject: [PATCH 04/87] Added links. --- EDUGraphAPIs/education-overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 8096bd07..adac6030 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -31,9 +31,9 @@ The following are some common use cases for the assignment-related Education API |Use case|Description|See also| |:-------|:----------|:-------| -|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|| -|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|| -|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| ## Rostering From 2a9e691a4959fd108b5a5e7abb2c2a4f208ed607 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 2 Nov 2017 11:58:03 -0700 Subject: [PATCH 05/87] Edit pass. --- .../resources/educationassignment.md | 28 +++++++++---------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index de6a2b3b..d48f0494 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -1,12 +1,10 @@ # educationAssignment resource type -**Assignment** is the core object of the Assignments API. Assignments are owned by a class and thus -most of the APIs are exposed in the class namespace. Only a teacher in a class can create an assignment. -Assignment starts in the "Draft" state when created. In draft, students will not see the assignment and submissions will not be created. -The status on an assignment cannot be changed via PATCH. It can only be changed using the action. - +The **educationAssignment** resource represents a task or unit of work assigned to a student or team member in a class as part of their study. Only teachers or team owners can create assignments. Assignments contain handouts and tasks that the teacher wants the student to work on. Each student assignment has an associated [submission](educationsubmissionresource.md) that contains any work their teacher asked to be turned in. A teacher can add scores and feedback to the submission turned in by the student. + +When an assignment is created, it is in a Draft state. Students can't see the assignment and submissions won't be created. You can change the status of an assignment by using the [publish](../api/educationassignment_publish.md) action. You can't use a PATCH request to change the assignment status. + +The assignment APIs are exposed in the class namespace. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md index 2ad3be07..bd518432 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md @@ -1,18 +1,18 @@ # educationAssignmentGrade resource type -Represents the **Grade** object on a Submission. This is an abstract type and will never be instantiated, however all types of grading (points, pass/fail, etc.) will all subclass from this -resource type. This object also tracks the who of the grading. This is used in the submission.grade property. +Represents the **Grade** object on a Submission. This is an abstract type that will never be instantiated; however, all types of grading (points, pass/fail, and so on) are subclasses of this +resource type. This object also tracks who is doing the grading. This is used in the **submission.grade** property. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |gradedBy|[identitySet](identityset.md)| User who did the grading. | -|gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| +|gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md index 937b7463..2474d6f8 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md @@ -1,7 +1,7 @@ # educationAssignmentPointsGrade resource type -When an assignment is set to points grade type, each submission will have this object associated with the submission.grade property. This subclasses from [educationAssignmentGrade](educationAssignmentGrade.md) -which will add the who data to this property. The max points is stored in the assignments.grading property. +When an assignment is set to a points grade type, each submission will have this object associated with the **submission.grade** property. This creates a subclass from [educationAssignmentGrade](educationAssignmentGrade.md), +which will add the who data to this property. The max points is stored in the **assignments.grading** property. ## Properties @@ -11,7 +11,7 @@ which will add the who data to this property. The max points is stored in the a ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md index 83b1d2c3..60d1b100 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md @@ -1,24 +1,24 @@ # educationAssignmentResource resource type -Wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will -be copied to the student submission. If the object is not copied, then each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a hand-out from the teacher to the student with nothing to be turned in. If the resource is distributed, each student -will receive a copy of this resource in the resource list of their assignment. Each student will be able to modify their copy and submit it for grading. +A wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will +be copied to the student submission. If the object is not copied, each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student +will receive a copy of this resource in the resource list of their assignment. Each student will be able to modify their copy and submit it for grading. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationAssignmentResource](../api/educationassignmentresource_get.md) | [educationAssignmentResource](educationassignmentresource.md) |Read properties and relationships of educationAssignmentResource object.| -|[Update](../api/educationassignmentresource_update.md) | [educationAssignmentResource](educationassignmentresource.md) |Update educationAssignmentResource object. | -|[Delete](../api/educationassignmentresource_delete.md) | None |Delete educationAssignmentResource object. | +|[Get educationAssignmentResource](../api/educationassignmentresource_get.md) | [educationAssignmentResource](educationassignmentresource.md) |Read properties and relationships of an **educationAssignmentResource** object.| +|[Update](../api/educationassignmentresource_update.md) | [educationAssignmentResource](educationassignmentresource.md) |Update an **educationAssignmentResource** object. | +|[Delete](../api/educationassignmentresource_delete.md) | None |Delete an **educationAssignmentResource** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |distributeForStudentWork|Boolean|Indicates whether this resource should be copied to each student submission for modification and submission.| -|id|String| ID of this resource. Read-only.| -|resource|[educationResource](educationresource.md)|Resource object that has been assoicated with this assignment.| +|id|String| ID of this resource. Read-only.| +|resource|[educationResource](educationresource.md)|Resource object that has been associated with this assignment.| ## Relationships None @@ -26,7 +26,7 @@ None ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |feedbackBy|[identitySet](identityset.md)|User who created the feedback.| -|feedbackDateTime|DateTimeOffset|Moment in time when the feedback was given. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| +|feedbackDateTime|DateTimeOffset|Moment in time when the feedback was given. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| |text|[itemBody](itembody.md)|Feedback.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. ->**Important:** This API currently an incorrect syntax. This will be -replaced by the representation (single property) like the rest of graph. Use this knowing it will change!! +>**Important:** This API currently uses a different syntax. This will be +replaced by the representation (single property). ## Properties | Property | Type |Description| |:---------------|:--------|:----------| |notebookId|String|Notebook ID of the OneNote for this resource.| -|pageId|String|Page Id of the OneNote.| -|sectionName|String|Section Name of the OneNote.| +|pageId|String|Page ID of the OneNote.| +|sectionName|String|Section name of the OneNote.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md index 726eaab4..a4b643da 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md @@ -1,19 +1,19 @@ # educationSubmissionResource resource type -Wrapper around resource for used on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment. +A wrapper around a resource for use on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationSubmissionResource](../api/educationsubmissionresource_get.md) | [educationSubmissionResource](educationsubmissionresource.md) |Read properties and relationships of educationSubmissionResource object.| -|[Delete](../api/educationsubmissionresource_delete.md) | None |Delete educationSubmissionResource object. | +|[Get educationSubmissionResource](../api/educationsubmissionresource_get.md) | [educationSubmissionResource](educationsubmissionresource.md) |Read properties and relationships of an **educationSubmissionResource** object.| +|[Delete](../api/educationsubmissionresource_delete.md) | None |Delete an **educationSubmissionResource** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|assignmentResourceUrl|String|Pointer to the assignment from which this resource was copied. If this is null, the student uploaded the resource.| +|assignmentResourceUrl|String|Pointer to the assignment from which this resource was copied. If this is null, the student uploaded the resource.| |id|String| Read-only.| |resource|[educationResource](educationresource.md)|Resource object.| @@ -23,7 +23,7 @@ None ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. \ No newline at end of file +}--> From f39324b80096f8f970d11f2b707cd1cd1ce8fec6 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 2 Nov 2017 16:24:10 -0700 Subject: [PATCH 08/87] Edit pass. --- .../api/educationassignment_delete.md | 14 ++++++--- .../api/educationassignment_get.md | 20 +++++++----- .../api/educationassignment_list_resources.md | 7 +++-- .../educationassignment_list_submissions.md | 9 ++++-- .../api/educationassignment_post_resources.md | 15 ++++----- .../api/educationassignment_publish.md | 11 ++++--- .../api/educationassignment_update.md | 31 ++++++++++--------- .../api/educationassignmentresource_delete.md | 11 ++++--- .../api/educationassignmentresource_update.md | 18 ++++++----- .../resources/educationassignment.md | 6 ++-- 10 files changed, 84 insertions(+), 58 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index 7e9dd7ec..9da2b02e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -1,6 +1,6 @@ # Delete educationAssignment -Use this API to delete an existing Assignment. No request body is necessary. Only Teachers within a Class can delete Assignments. +Delete an existing assignment. Only teachers within a class can delete assignments. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -28,26 +28,30 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. -```http +```http DELETE https://graph.microsoft.com/beta/education/classes//assignments/ ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. + + ```http HTTP/1.1 204 No Content ``` diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_get.md b/EDUGraphAPIs/Assignments/api/educationassignment_get.md index cb1998d1..a6d80e38 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_get.md @@ -1,16 +1,17 @@ # Get educationAssignment -Use this API to get an assignment properties and its relationships. Students can only see assignments assigned to them while teachers can see all assignments in a class. +Get the properties and relationships of an assignment. Students can only see assignments assigned to them; teachers can see all assignments in a class. + + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). - ->**Note:** Due to a bug, the graph will return educationItemBody for the instructions property. This is an exact duplicate of the itemBody that -is already found on the graph. When the code moves to production, this will be updated. For clients who simply use the json being sent back and forth to the graph, there should be no work necessary to handle this change. - - |Permission type | Permissions (from least to most privileged) | |:--------------------|:---------------------------------------------------------| |Delegated (work or school account) | EduAssignments.ReadBasic, EduAssignments.ReadWriteBasic, EduAssignments.Read, EduAssignments.ReadWrite | @@ -37,7 +38,7 @@ Do not supply a request body for this method. If successful, this method returns a `200 OK` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -29,24 +29,24 @@ PATCH /education/classes//assignments/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|allowLateSubmissions|Boolean| Whether submisions can be submitted after the due date| -|allowStudentsToAddResourcesToSubmission|Boolean| Wether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. | -|assignDateTime|DateTimeOffset| Date the assignmetn should be published to students. | -|assignTo|educationAssignmentRecipient| Students who get the assignment| +|allowLateSubmissions|Boolean| Whether submissions can be submitted after the due date.| +|allowStudentsToAddResourcesToSubmission|Boolean| Whether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. | +|assignDateTime|DateTimeOffset| Date the assignment should be published to students. | +|assignTo|educationAssignmentRecipient| Students who get the assignment.| |displayName|String| Name of assignment. | |dueDateTime|DateTimeOffset| Date assignment is due. | |grading|educationAssignmentGradeType| How the assignment will be graded.| |instructions|itemBody| Instructions to be given to the students along with the assignment. | ## Response -If successful, this method returns a `200 OK` response code and updated [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Methods From 938a12d297b1ea8f737f4c4456fb1b57ffa52901 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 6 Nov 2017 16:48:33 -0800 Subject: [PATCH 09/87] Edit pass. --- .../Assignments/api/educationassignmentresource_get.md | 9 ++++++--- .../Assignments/api/educationclass_list_assignments.md | 4 +--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md index e03245eb..71a73e67 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md @@ -26,10 +26,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationAssignmentResource](../resources/educationassignmentresource.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -32,10 +33,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignment](../resources/educationassignment.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -30,15 +30,15 @@ POST /education/classes//assignments | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationAssignment](../resources/educationassignment.md) object. +In the request body, supply a JSON representation of an [educationAssignment](../resources/educationassignment.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -27,10 +29,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSubmissionResource](../resources/educationsubmissionresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSubmissionResource](../resources/educationsubmissionresource.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. \ No newline at end of file +}--> From bd5f37bf26e8508bf7a1569b59a23c849208c72d Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 10:26:02 -0800 Subject: [PATCH 15/87] Fixed formatting. --- EDUGraphAPIs/Rostering/resources/educationuser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Rostering/resources/educationuser.md b/EDUGraphAPIs/Rostering/resources/educationuser.md index 3887eb9a..d82f0c26 100644 --- a/EDUGraphAPIs/Rostering/resources/educationuser.md +++ b/EDUGraphAPIs/Rostering/resources/educationuser.md @@ -20,7 +20,7 @@ This object provides a targeted subset of properties from the core [user](user.m |accountEnabled|Boolean| **true** if the account is enabled; otherwise, **false**. This property is required when a user is created. Supports $filter. | |assignedLicenses|[assignedLicense](assignedlicense.md) collection|The licenses that are assigned to the user. Not nullable. | |assignedPlans|[assignedPlan](assignedplan.md) collection|The plans that are assigned to the user. Read-only. Not nullable. | -|businessPhones|String collection|The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property.| +|businessPhones|String collection|The telephone numbers for the user. **Note:** Although this is a string collection, only one number can be set for this property.| |createdBy|[identitySet](identityset.md)| Entity who created the user. | |department|String|The name for the department in which the user works. Supports $filter.| |displayName|String|The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby.| From bec91c96fb9b41a348173bae239319c50c141901 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 10:30:54 -0800 Subject: [PATCH 16/87] Edit pass. --- .../Assignments/api/educationsubmission_recall.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md index cddbda1a..ccefe6d5 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md @@ -1,6 +1,6 @@ # educationSubmission: recall -Action which indicates that a student wants to take back a submission. This action can only be done by a student. It will change the status of this submission from "submitted" back to "working". +Indicates that a student wants to take back a submission. This action can only be done by a student. It will change the status of the submission from "submitted" back to "working". ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -25,12 +25,12 @@ POST /education/classes//assignments//submissions//recall ## Request body ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of the request. +```http +POST /education/classes//assignments//getResourcesFolderUrl + +``` +## Request headers +| Header | Value | +|:---------------|:--------| +| Authorization | Bearer {token}. Required. | + +## Request body + +## Response +If successful, this method returns a `200 Ok` response code. The Body will contain the One Drive URL of a folder to put all file based resources. + +## Example +The following example shows how to call this API. +##### Request +The following is an example of a request. + +```http +POST https://graph.microsoft.com/beta/education/classes//assignments//getResourcesFolderUrl +``` + +##### Response +The following is an example of a response. + + +```http +HTTP/1.1 200 OK +Content-type: application/json +Content-length: 279 + +{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.String", + "value": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeT456457AdW9f/items/017NJZI25NOB5XZNLABF7646XAMDZTQQ6T" +} +``` + + + \ No newline at end of file diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index d57f1b5c..691b4df8 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -78,7 +78,6 @@ Content-length: 344 "instructions": {"@odata.type": "microsoft.graph.itemBody"}, "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedDateTime": "String (timestamp)", - "resourcesFolderUrl": "String", "status": "string" } ] diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index c10d26e7..d224fc26 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -96,7 +96,6 @@ Content-length: 279 "instructions": {"@odata.type": "microsoft.graph.itemBody"}, "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedDateTime": "String (timestamp)", - "resourcesFolderUrl": "String", "status": "string" } ``` diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 068c53eb..8c41c4ec 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -77,7 +77,6 @@ Content-length: 344 "instructions": {"@odata.type": "microsoft.graph.itemBody"}, "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedDateTime": "String (timestamp)", - "resourcesFolderUrl": "String", "status": "string" } ] diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index 7a471c57..df738d2b 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -22,6 +22,7 @@ sent back and forth to Microsoft Graph, there should be no work necessary to han |[Update](../api/educationassignment_update.md) | [educationAssignment](educationassignment.md) |Update an **educationAssignment** object. | |[Delete](../api/educationassignment_delete.md) | None |Delete an **educationAssignment** object. | |[Publish](../api/educationassignment_publish.md)|[educationAssignment](educationassignment.md)|Change the state of an **educationAssignment** object from draft to published.| +|[GetResourceFolderUrl](../api/educationassignment_getResourcesFolderUrl.md)| string| OneDrive folder into which file based resource should be put to be part of a assignment resource. Files must live in this folder to be added as a resource.| ## Properties | Property | Type |Description| @@ -41,7 +42,6 @@ sent back and forth to Microsoft Graph, there should be no work necessary to han |instructions|[itemBody](itembody.md)| Instructions for the assignment. This along with the display name tell the student what to do. | |lastModifiedBy|[identitySet](identityset.md)| Who last modified the assignment. | |lastModifiedDateTime|DateTimeOffset|Moment when the assignment was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: `'2014-01-01T00:00:00Z'`| -|resourcesFolderUrl|String| Folder into which file based resource should be put to be part of a assignment resource. Files must live in this folder to be added as a resource.| |status|string| Status of the **Assignment**. You can not PATCH this value. Possible values are: `draft`, `published`, `assigned`.| ## Relationships @@ -79,7 +79,6 @@ The following is a JSON representation of the resource. "instructions": {"@odata.type": "microsoft.graph.itemBody"}, "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedDateTime": "String (timestamp)", - "resourcesFolderUrl": "String", "status": "string" } ``` diff --git a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md index 04640e43..5d2f231e 100644 --- a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md @@ -11,9 +11,8 @@ replaced by the representation (single property). ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|notebookId|String|Notebook ID of the OneNote for this resource.| -|pageId|String|Page ID of the OneNote.| -|sectionName|String|Section name of the OneNote.| +|pageUrl|String|Graph URL to the Page in OneNote.| +|sectionName|String|Section name that distributions should be copied into or were copied into.| ## JSON representation @@ -29,8 +28,7 @@ The following is a JSON representation of the resource. ```json { - "notebookId": "String", - "pageId": "String", + "pageUrl": "String", "sectionName": "String" } From 131bdc1429833da7166981ab7fad36d90a7634b2 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 15:43:27 -0800 Subject: [PATCH 18/87] Update topic organization. --- EDUGraphAPIs/education-overview.md | 35 ++++++++++++++---------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index adac6030..48c25ba2 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -12,29 +12,13 @@ The Education APIs in Microsoft Graph enhance Office 365 resources and data with The Education APIs include two new resources, **Rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. - + ## Authorization To call the Education APIs in Microsoft Graph, your app will need the appropriate permissions. For more information about permissions for Education APIs, see [Permissions](../../../concepts/permissions_reference.md). -## Assignments - -You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. - - - -The following are some common use cases for the assignment-related Education APIs. - -|Use case|Description|See also| -|:-------|:----------|:-------| -|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| -|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| -|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| - ## Rostering The rostering APIs enable you to extract data from a school's Office 365 tenant provisioned with Microsoft School Data Sync. These APIs provide access to information about schools, sections, teachers, students, and rosters. The APIs support both app-only (sync) scenarios, and app + user (interactive) scenarios. The APIs that support interactive scenarios enforce region-appropriate RBAC policies based on the user role calling the API. This provides a consistent API and minimal policy surface, regardless of the administrative configuration within tenants. In addition, the APIs also provide education-specific permissions to ensure that the right user has access to the data. @@ -53,6 +37,21 @@ The rostering APIs support support the following scenarios: - get teachers/students - Get my schools/classes +## Assignments + +You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. + + + +The following are some common use cases for the assignment-related Education APIs. + +|Use case|Description|See also| +|:-------|:----------|:-------| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| ## Next steps Use the Microsoft Graph Education APIs to build education solutions that access student assignments and school rosters. To learn more: @@ -60,5 +59,3 @@ Use the Microsoft Graph Education APIs to build education solutions that access - Explore the resources and methods that are most helpful to your scenario. - Try the API in the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer). - - From 9f274d72e43b4b9ce67597b9694b7235fe95318d Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 15:59:45 -0800 Subject: [PATCH 19/87] Edits. --- .../api/educationassignment_getResourcesFolderUrl.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index 7b613abe..447ab052 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -1,8 +1,7 @@ # educationAssignment: getResourcesFolderUrl -This function returns the OneDrive URL where all file based resources (files/Word/excel/etc) should be uploaded. -Note that files must live in this folder for them to be added as Resources. -Only a teacher in the class can make this call. +This function returns the OneDrive URL where all file-based resources (Word, Excel, and so on) should be uploaded. +Note that files must be located in this folder in order to be added as resources. Only a teacher in the class can determine what files to upload. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -27,7 +26,7 @@ POST /education/classes//assignments//getResourcesFolderUrl ## Request body ## Response -If successful, this method returns a `200 Ok` response code. The Body will contain the One Drive URL of a folder to put all file based resources. +If successful, this method returns a `200 Ok` response code. The body will contain the OneDrive URL of a folder in which to put all file-based resources. ## Example The following example shows how to call this API. @@ -68,4 +67,4 @@ Content-length: 279 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 5ce1bd2baf5528f3b4f5533f074601bbcd05ab68 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 16:00:58 -0800 Subject: [PATCH 20/87] Edits. --- EDUGraphAPIs/Assignments/resources/educationassignment.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index df738d2b..3c6a1c66 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -22,7 +22,7 @@ sent back and forth to Microsoft Graph, there should be no work necessary to han |[Update](../api/educationassignment_update.md) | [educationAssignment](educationassignment.md) |Update an **educationAssignment** object. | |[Delete](../api/educationassignment_delete.md) | None |Delete an **educationAssignment** object. | |[Publish](../api/educationassignment_publish.md)|[educationAssignment](educationassignment.md)|Change the state of an **educationAssignment** object from draft to published.| -|[GetResourceFolderUrl](../api/educationassignment_getResourcesFolderUrl.md)| string| OneDrive folder into which file based resource should be put to be part of a assignment resource. Files must live in this folder to be added as a resource.| +|[GetResourceFolderUrl](../api/educationassignment_getResourcesFolderUrl.md)| string| OneDrive folder into which file-based resources should be put to be part of a assignment resource. Files must be located in this folder to be added as a resource.| ## Properties | Property | Type |Description| @@ -91,4 +91,4 @@ The following is a JSON representation of the resource. "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 71f9d73ce9aea079e03569aba56a483ef0c7cac9 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 16:02:21 -0800 Subject: [PATCH 21/87] Edit. --- .../Assignments/resources/educationonenoteresource.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md index 5d2f231e..586d10d0 100644 --- a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md @@ -11,7 +11,7 @@ replaced by the representation (single property). ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|pageUrl|String|Graph URL to the Page in OneNote.| +|pageUrl|String|The Microsoft Graph URL to the page in OneNote.| |sectionName|String|Section name that distributions should be copied into or were copied into.| ## JSON representation @@ -42,4 +42,4 @@ The following is a JSON representation of the resource. "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 14c7565f8a78a2917da4a74b662ec8a198e2ae68 Mon Sep 17 00:00:00 2001 From: "wiggs@wiggenout.com" Date: Wed, 8 Nov 2017 16:12:56 -0800 Subject: [PATCH 22/87] add request body --- .../api/educationassignment_getResourcesFolderUrl.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index 7b613abe..6012edbc 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -25,7 +25,7 @@ POST /education/classes//assignments//getResourcesFolderUrl | Authorization | Bearer {token}. Required. | ## Request body - +Do not supply a request body for this method. ## Response If successful, this method returns a `200 Ok` response code. The Body will contain the One Drive URL of a folder to put all file based resources. From d1e007f2f5badfc0e54588d09afac76bff0fbfae Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 17:18:47 -0800 Subject: [PATCH 23/87] Edit pass. --- .../api/educationsubmission_post_resources.md | 2 +- .../api/educationsubmission_release.md | 15 +++++++++------ .../Assignments/api/educationsubmission_submit.md | 12 +++++++----- .../Assignments/api/educationsubmission_update.md | 15 ++++++++++----- .../api/educationsubmissionresource_delete.md | 11 +++++++---- 5 files changed, 34 insertions(+), 21 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md index 06ea3251..36138167 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md @@ -28,7 +28,7 @@ In the request body, supply a JSON representation of the [educationSubmissionRes ## Response -If successful, this method returns a `201 Created` response code and an[educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationSubmissionResource](../resources/educationsubmissionresource.md) object in the response body. ## Example ##### Request diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md index 0970eba1..1726b47e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md @@ -1,6 +1,6 @@ # educationSubmission: release -Action makes the grade and feedback associated with this submission available back to the student. This will change the status of the submission from "submitted" to "released" and indicates that grading is done. This action can only be done by the teacher. +This action makes the grade and feedback associated with this submission available to the student. This will change the status of the submission from "submitted" to "released" and indicates that grading is done. This action can only be done by the teacher. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -23,24 +23,27 @@ POST /education/classes//assignments//submissions//release | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example -Here is an example of how to call this API. +The following example shows how to call this API. ##### Request -Here is an example of the request. +The following is an example of the request. -##### Response ```http POST https://graph.microsoft.com/beta/education/classes//assignments//submissions//release ``` -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. + +##### Response +The following is an example of the response. + | Property | Type |Description| |:---------------|:--------|:----------| @@ -30,10 +32,10 @@ In the request body, supply the values for relevant fields that should be update |grade|educationAssignmentGrade|| ## Response -If successful, this method returns a `200 OK` response code and updated [educationSubmission](../resources/educationsubmission.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationSubmission](../resources/educationsubmission.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index b97efe21..0581d476 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -2,12 +2,6 @@ Update the assignment object. Only teachers in the class can do this. Note that you can't use a PATCH request to change the status of an assignment. Use the [publish](../api/educationassignment_publish.md) action to change the assignment status. - - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index 691b4df8..4226d637 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -2,12 +2,6 @@ Retrieve a list of assignment objects. A teacher is allowed to see all assignment objects for the class. Students can only see assignments that are assigned to them. - - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index d224fc26..9bf5fca9 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -2,12 +2,6 @@ Creates a new assignment. Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publish is called. - - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 68b9a0072ec9bc7a8286f83773593e3cadecbdee Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 17:34:12 -0800 Subject: [PATCH 26/87] Removed note. --- EDUGraphAPIs/Assignments/resources/educationassignment.md | 5 ----- EDUGraphAPIs/Assignments/resources/educationfeedback.md | 5 ----- 2 files changed, 10 deletions(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index 3c6a1c66..661877b9 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -6,11 +6,6 @@ When an assignment is created, it is in a Draft state. Students can't see the as The assignment APIs are exposed in the class namespace. - ## Methods | Method | Return Type |Description| diff --git a/EDUGraphAPIs/Assignments/resources/educationfeedback.md b/EDUGraphAPIs/Assignments/resources/educationfeedback.md index a1d77a57..8bf508ec 100644 --- a/EDUGraphAPIs/Assignments/resources/educationfeedback.md +++ b/EDUGraphAPIs/Assignments/resources/educationfeedback.md @@ -2,11 +2,6 @@ Feedback from a teacher to a student. This property represents both the text part of the feedback along with the who. - ## Properties | Property | Type |Description| From 52300aa394900632a224bdec39170b81a4ec9030 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 8 Nov 2017 17:45:46 -0800 Subject: [PATCH 27/87] Edit pass. --- .../Rostering/resources/educationclass.md | 42 +++++++++---------- .../resources/educationorganization.md | 6 +-- 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/EDUGraphAPIs/Rostering/resources/educationclass.md b/EDUGraphAPIs/Rostering/resources/educationclass.md index d6828f59..3e0c0067 100644 --- a/EDUGraphAPIs/Rostering/resources/educationclass.md +++ b/EDUGraphAPIs/Rostering/resources/educationclass.md @@ -1,39 +1,37 @@ # educationClass resource type -Represents a class within a school. educationClass corresponds one-to-one with Office Group and shares the same id. -Students are modeled as regular members of the class, while teachers are modeled as owners and have appropriate rights. -For correct operation of Office experiences, teachers must be members of both the teachers and members collections. +Represents a class within a school. The **educationClass** resource corresponds to the Office Group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections. ## Methods | Method | Return Type |Description| |:---------------|:--------|:----------| -|[Get educationClass](../api/educationclass_get.md) | [educationClass](educationclass.md) |Read properties and relationships of educationClass object.| -|[Add member](../api/educationclass_post_members.md) |[educationUser](educationuser.md)| Add a new educationUser for the class by posting to the members navigation property.| -|[List members](../api/educationclass_list_members.md) |[educationUser](educationuser.md) collection| Get a educationUser object collection.| -|[Remove member](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an educationUser from the class through the members navigation property.| -|[List schools](../api/educationclass_list_schools.md) |[educationSchool](educationschool.md) collection| Get a educationSchool object collection.| -|[Add teacher](../api/educationclass_post_teachers.md) |[educationUser](educationuser.md)| Add a new educationUser for the class by posting to the teachers navigation property.| +|[Get educationClass](../api/educationclass_get.md) | [educationClass](educationclass.md) |Read properties and relationships of an **educationClass** object.| +|[Add member](../api/educationclass_post_members.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the members navigation property.| +|[List members](../api/educationclass_list_members.md) |[educationUser](educationuser.md) collection| Get an **educationUser** object collection.| +|[Remove member](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the members navigation property.| +|[List schools](../api/educationclass_list_schools.md) |[educationSchool](educationschool.md) collection| Get an **educationSchool** object collection.| +|[Add teacher](../api/educationclass_post_teachers.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the teachers navigation property.| |[List teachers](../api/educationclass_list_teachers.md) |[educationUser](educationuser.md) collection| Get a list of teachers for the class.| -|[Remove teacher](../api/educationclass_delete_teachers.md) |[educationUser](educationuser.md)| Remove an educationUser from the class through the teachers navigation property.| -|[Create educationAssignment](../../Assignments/api/educationclass_post_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md)| Create a new educationAssignment by posting to the assignments collection.| -|[List assignments](../../Assignments/api/educationclass_list_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md) collection| Get a educationAssignment object collection.| -|[Update](../api/educationclass_update.md) | [educationClass](educationclass.md) |Update educationClass object. | -|[Delete](../api/educationclass_delete.md) | None |Delete educationClass object. | +|[Remove teacher](../api/educationclass_delete_teachers.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the teachers navigation property.| +|[Create educationAssignment](../../Assignments/api/educationclass_post_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md)| Create a new **educationAssignment** by posting to the assignments collection.| +|[List assignments](../../Assignments/api/educationclass_list_assignments.md) |[educationAssignment](../../Assignments/resources/educationassignment.md) collection| Get an **educationAssignment** object collection.| +|[Update](../api/educationclass_update.md) | [educationClass](educationclass.md) |Update **educationClass** object. | +|[Delete](../api/educationclass_delete.md) | None |Delete **educationClass** object. | ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|id| String| Unique identifier for the class| -|description|String| Description of the class| -|displayName|String| Name of the class| +|id| String| Unique identifier for the class.| +|description|String| Description of the class.| +|displayName|String| Name of the class.| |mailNickname|String| Mail name for sending email to all members, if this is enabled. | |createdBy|[identitySet](identityset.md)| Entity who created the class | -|classCode|String| Class Code used by the school to identify the class.| +|classCode|String| Class code used by the school to identify the class.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `unknownFutureValue`.| +|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `unknownFutureValue`.| |term|[educationTerm](educationterm.md)|Term for this class.| @@ -41,13 +39,13 @@ For correct operation of Office experiences, teachers must be members of both th | Relationship | Type |Description| |:---------------|:--------|:----------| |members|[educationUser](educationuser.md) collection| All users in the class. Nullable.| -|schools|[educationSchool](educationschool.md) collection| All schools this class is associated with. Nullable.| -|teachers|[educationUser](educationuser.md) collection| All teachers in the class. Nullable.| +|schools|[educationSchool](educationschool.md) collection| All schools that this class is associated with. Nullable.| +|teachers|[educationUser](educationuser.md) collection| All teachers in the class. Nullable.| |assignments|[educationAssignment](../../Assignments/resources/educationassignment.md) collection| All assignments associated with this class. Nullable.| ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. -The Education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. +The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The Education APIs include two new resources, **Rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. +The education APIs include two new resources, **rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. - + ## Authorization -To call the Education APIs in Microsoft Graph, your app will need the appropriate permissions. -For more information about permissions for Education APIs, see [Permissions](../../../concepts/permissions_reference.md). +To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. +For more information about permissions for education APIs, see [Permissions](../../../concepts/permissions_reference.md). ## Rostering @@ -39,13 +39,13 @@ The rostering APIs support support the following scenarios: ## Assignments -You can use the assignment-related Education APIs to integrate with the Assignments service in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same Education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. +You can use the assignment-related education APIs to integrate with assignments in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. -The following are some common use cases for the assignment-related Education APIs. +The following are some common use cases for the assignment-related education APIs. |Use case|Description|See also| |:-------|:----------|:-------| @@ -54,7 +54,7 @@ The following are some common use cases for the assignment-related Education API |Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| ## Next steps -Use the Microsoft Graph Education APIs to build education solutions that access student assignments and school rosters. To learn more: +Use the Microsoft Graph education APIs to build education solutions that access student assignments and school rosters. To learn more: - Explore the resources and methods that are most helpful to your scenario. - Try the API in the [Graph Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer). From d822021081020f97e2cd43638fbcebed4ab450e4 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Fri, 10 Nov 2017 16:48:52 -0800 Subject: [PATCH 32/87] Added links to assignment and rostering resources and APIs. --- EDUGraphAPIs/education-overview.md | 41 ++++++++++++++++++++++++++---- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index fa8559b9..518b9d6a 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -29,13 +29,27 @@ You can use the rostering APIs to enable an app user to know: - What classes I attend or teach - What I need to do and by when +The rostering APIs provide the following key resources: + +- [educationSchool](resources/educationschool.md) - Represents the school. +- [educationClass](resources/educationclass.md) - Represents a class within a school. +- [educationTerm](resources/educationterm.md) - Represents a designated portion of the academic year. +- [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. +- [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. + The rostering APIs support support the following scenarios: -- Get roster -- Get schools -- Get classes -- get teachers/students -- Get my schools/classes +- [Get students and teachers for a class](./api/educationclass_list_members.md) +- [List schools in which a class is taught](./api/educationclass_list_schools.md) +- [List teachers for a class](./api/educationclass_list_teachers.md) +- [Add members to a class](./api/educationclass_post_members.md) +- [Get all classes](./api/educationroot_list_classes.md ) +- [List all schools](./api/educationroot_list_schools.md) +- [Get classes in a school](./api/educationschool_list_classes.md) +- [Get users in a school](./api/educationschool_list_users.md) +- [Add classes to a school](./api/educationschool_post_classes.md) +- [List classes for a user](./api/educationuser_list_classes.md) +- [List schools for a user](./api/educationuser_list_schools.md) ## Assignments @@ -45,6 +59,22 @@ You can use the assignment-related education APIs to integrate with assignments The Public API is the same API that _Microsoft Teams in Office 365 for Education_ built it's user interface with. Thus, the best sample of what can be built with the Microsoft **Assignments** API is _Microsoft Teams in Office 365 for Education_. --> +The assignment APIs provide the following key resources: + +- [educationAssignment](./resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. +- [educationSubmission](.resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. +- [educationResource](resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. + +The assignment APIs support the following scenarios: + +- [Create assignment](./api/educationclass_post_assignments.md) +- [Publish assignment](./api/educationassignment_publish.md) +- [Create assignment resource](./api/educationassignment_post_resources.md) +- [Create submission resource](./api/educationsubmission_post_resources.md) +- [Submit assignment](./api/educationsubmission_submit.md) +- [Release grades to student](./api/educationsubmission_release.md) +- [Get assignment details](./api/educationuser_list_assignments.md) + The following are some common use cases for the assignment-related education APIs. |Use case|Description|See also| @@ -53,6 +83,7 @@ The following are some common use cases for the assignment-related education API |Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| |Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| + ## Next steps Use the Microsoft Graph education APIs to build education solutions that access student assignments and school rosters. To learn more: From 7033643864c10e15fed585a65e38c4d5a7ae586b Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Fri, 10 Nov 2017 16:58:12 -0800 Subject: [PATCH 33/87] Updates. --- EDUGraphAPIs/education-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 518b9d6a..419e528d 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -12,7 +12,7 @@ The education APIs in Microsoft Graph enhance Office 365 resources and data with The education APIs include two new resources, **rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. - + ## Authorization From fb27d069b8cc12d58874c0514dba2f7fe638326d Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Fri, 10 Nov 2017 16:59:57 -0800 Subject: [PATCH 34/87] Edit pass. --- .../Rostering/api/educationclass_list_schools.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 32078291..55f637c8 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -1,6 +1,8 @@ # List schools -Retrieve a list of schools which teach the class. +Retrieve a list of schools in which the class is taught. + + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -28,10 +30,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. +- [educationSchool](rostering/resources/educationschool.md) - Represents the school. +- [educationClass](resources/educationclass.md) - Represents a class within a school. +- [educationTerm](resources/educationterm.md) - Represents a designated portion of the academic year. +- [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. +- [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. The rostering APIs support the following scenarios: + - +- [List all schools](rostering/api/educationroot_list_schools.md) +- [List schools in which a class is taught](./api/educationclass_list_schools.md) +- [List schools for a user](./api/educationuser_list_schools.md) +- [Get all classes](./api/educationroot_list_classes.md ) +- [Get classes in a school](./api/educationschool_list_classes.md) +- [List classes for a user](./api/educationuser_list_classes.md) +- [Add classes to a school](./api/educationschool_post_classes.md) +- [Get students and teachers for a class](./api/educationclass_list_members.md) +- [Add members to a class](./api/educationclass_post_members.md) +- [List teachers for a class](./api/educationclass_list_teachers.md) +- [Get users in a school](./api/educationschool_list_users.md) ## Assignments From 37452ac1576a166a1c00ca99d23e011ee46b4f41 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 12:34:27 -0800 Subject: [PATCH 40/87] Test link fix. --- EDUGraphAPIs/education-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 400dfe0d..4bdfe1dd 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -37,7 +37,7 @@ The rostering APIs provide the following key resources: - [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. - [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. --> -- [educationSchool](rostering/resources/educationschool.md) - Represents the school. +- [educationSchool](../Rostering/resources/educationschool.md) - Represents the school. - [educationClass](resources/educationclass.md) - Represents a class within a school. - [educationTerm](resources/educationterm.md) - Represents a designated portion of the academic year. - [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. @@ -59,7 +59,7 @@ The rostering APIs support the following scenarios: - [Get users in a school](./api/educationschool_list_users.md) --> -- [List all schools](rostering/api/educationroot_list_schools.md) +- [List all schools](../Rostering/api/educationroot_list_schools.md) - [List schools in which a class is taught](./api/educationclass_list_schools.md) - [List schools for a user](./api/educationuser_list_schools.md) - [Get all classes](./api/educationroot_list_classes.md ) From 64527781606df5ba3d242529aadb3d77d213b314 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 12:37:27 -0800 Subject: [PATCH 41/87] test link fix. --- EDUGraphAPIs/education-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 4bdfe1dd..d6079c0a 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -37,7 +37,7 @@ The rostering APIs provide the following key resources: - [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. - [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. --> -- [educationSchool](../Rostering/resources/educationschool.md) - Represents the school. +- [educationSchool](Rostering/resources/educationschool.md) - Represents the school. - [educationClass](resources/educationclass.md) - Represents a class within a school. - [educationTerm](resources/educationterm.md) - Represents a designated portion of the academic year. - [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. @@ -59,7 +59,7 @@ The rostering APIs support the following scenarios: - [Get users in a school](./api/educationschool_list_users.md) --> -- [List all schools](../Rostering/api/educationroot_list_schools.md) +- [List all schools](Rostering/api/educationroot_list_schools.md) - [List schools in which a class is taught](./api/educationclass_list_schools.md) - [List schools for a user](./api/educationuser_list_schools.md) - [Get all classes](./api/educationroot_list_classes.md ) From a700aee9d5a52d8e49f34715842f0241a723268a Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 12:42:07 -0800 Subject: [PATCH 42/87] Update links. --- EDUGraphAPIs/education-overview.md | 58 +++++++++++++++--------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index d6079c0a..8cbb385f 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -10,14 +10,14 @@ The Microsoft Graph API provides access to Office 365 resources through one REST The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The education APIs include two new resources, **rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. +The education APIs include two new resources, **rostering** and [educationAssignment](Rostering/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. ## Authorization To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. -For more information about permissions for education APIs, see [Permissions](../../../concepts/permissions_reference.md). +For more information about permissions for education APIs, see [Permissions](permissions_reference.md). ## Rostering @@ -38,10 +38,10 @@ The rostering APIs provide the following key resources: - [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. --> - [educationSchool](Rostering/resources/educationschool.md) - Represents the school. -- [educationClass](resources/educationclass.md) - Represents a class within a school. -- [educationTerm](resources/educationterm.md) - Represents a designated portion of the academic year. -- [educationTeacher](resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. -- [educationStudent](resources/educationstudent.md) - Represents a users with the primary role of 'student'. +- [educationClass](Rostering/resources/educationclass.md) - Represents a class within a school. +- [educationTerm](Rostering/resources/educationterm.md) - Represents a designated portion of the academic year. +- [educationTeacher](Rostering/resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. +- [educationStudent](Rostering/resources/educationstudent.md) - Represents a users with the primary role of 'student'. The rostering APIs support the following scenarios: @@ -60,16 +60,16 @@ The rostering APIs support the following scenarios: --> - [List all schools](Rostering/api/educationroot_list_schools.md) -- [List schools in which a class is taught](./api/educationclass_list_schools.md) -- [List schools for a user](./api/educationuser_list_schools.md) -- [Get all classes](./api/educationroot_list_classes.md ) -- [Get classes in a school](./api/educationschool_list_classes.md) -- [List classes for a user](./api/educationuser_list_classes.md) -- [Add classes to a school](./api/educationschool_post_classes.md) -- [Get students and teachers for a class](./api/educationclass_list_members.md) -- [Add members to a class](./api/educationclass_post_members.md) -- [List teachers for a class](./api/educationclass_list_teachers.md) -- [Get users in a school](./api/educationschool_list_users.md) +- [List schools in which a class is taught](Rostering/api/educationclass_list_schools.md) +- [List schools for a user](Rostering/api/educationuser_list_schools.md) +- [Get all classes](Rostering/api/educationroot_list_classes.md ) +- [Get classes in a school](Rostering/api/educationschool_list_classes.md) +- [List classes for a user](Rostering/api/educationuser_list_classes.md) +- [Add classes to a school](Rostering/api/educationschool_post_classes.md) +- [Get students and teachers for a class](Rostering/api/educationclass_list_members.md) +- [Add members to a class](Rostering/api/educationclass_post_members.md) +- [List teachers for a class](Rostering/api/educationclass_list_teachers.md) +- [Get users in a school](Rostering/api/educationschool_list_users.md) ## Assignments @@ -81,27 +81,27 @@ The Public API is the same API that _Microsoft Teams in Office 365 for Education The assignment APIs provide the following key resources: -- [educationAssignment](./resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. -- [educationSubmission](.resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. -- [educationResource](resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. +- [educationAssignment](Assignments/resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. +- [educationSubmission](Assignments/resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. +- [educationResource](Assignments/resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. The assignment APIs support the following scenarios: -- [Create assignment](./api/educationclass_post_assignments.md) -- [Publish assignment](./api/educationassignment_publish.md) -- [Create assignment resource](./api/educationassignment_post_resources.md) -- [Create submission resource](./api/educationsubmission_post_resources.md) -- [Submit assignment](./api/educationsubmission_submit.md) -- [Release grades to student](./api/educationsubmission_release.md) -- [Get assignment details](./api/educationuser_list_assignments.md) +- [Create assignment](Assignments/api/educationclass_post_assignments.md) +- [Publish assignment](Assignments/api/educationassignment_publish.md) +- [Create assignment resource](Assignments/api/educationassignment_post_resources.md) +- [Create submission resource](Assignments/api/educationsubmission_post_resources.md) +- [Submit assignment](Assignments/api/educationsubmission_submit.md) +- [Release grades to student](Assignments/api/educationsubmission_release.md) +- [Get assignment details](Assignments/api/educationuser_list_assignments.md) The following are some common use cases for the assignment-related education APIs. |Use case|Description|See also| |:-------|:----------|:-------| -|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| -|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| -|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](Assignments/api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](Assignments/api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](Assignments/resources/educationsubmission.md)| ## Next steps From b03f4c1b6df0edfcc49784272f542233500b5a74 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 13:05:47 -0800 Subject: [PATCH 43/87] Fix link. --- EDUGraphAPIs/education-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 8cbb385f..65d85e21 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -10,14 +10,14 @@ The Microsoft Graph API provides access to Office 365 resources through one REST The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The education APIs include two new resources, **rostering** and [educationAssignment](Rostering/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. +The education APIs include two new resources, **rostering** and [educationAssignment](Assignments/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. ## Authorization To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. -For more information about permissions for education APIs, see [Permissions](permissions_reference.md). +For more information about permissions for education APIs, see [Permissions](EDUGraphAPIs/permissions_reference.md). ## Rostering From b0af6ab6604d093fac2025e3a407e96a6a96fca0 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 13:12:12 -0800 Subject: [PATCH 44/87] Deleted files. --- EDUGraphAPIs/Assignments/GettingStarted.md | 59 ---------------------- EDUGraphAPIs/Rostering/GettingStarted.md | 59 ---------------------- 2 files changed, 118 deletions(-) delete mode 100644 EDUGraphAPIs/Assignments/GettingStarted.md delete mode 100644 EDUGraphAPIs/Rostering/GettingStarted.md diff --git a/EDUGraphAPIs/Assignments/GettingStarted.md b/EDUGraphAPIs/Assignments/GettingStarted.md deleted file mode 100644 index 3ac71428..00000000 --- a/EDUGraphAPIs/Assignments/GettingStarted.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft Education Graph Assignments API : Getting Started - - This document provides information for getting started with assignments API. - - ### Understanding Scopes - - The Assignment Service adds a few new scopes to the **Microsoft Graph**. These scopes are used to access Assignment information. The scope applies to all the **Assignment** objects including [Assignment](./resources/educationassignment.md), [Resource](./resources/educationresource.md), and [Submission](./resources/educationsubmission.md). With an App+User Context, the API will only return objects that the user has access to. The "Basic" scopes work the same as the non-basic equivalent scopes, however grade information will not be returned in the Submission objects for "Basic" scopes. - - >**Note:** Students can only access their own Submission. - -#### App-Only Context - -| Role (scope) | Display Name |Description| -|:-----------------|:-------------------|:----------| -|EduAssignments.ReadBasic.All| Read class assignments without grades|Allows the app to read assignments without grades for all users| -|EduAssignments.ReadWriteBasic.All | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| -|EduAssignments.Read.All| Read class assignments with grades | Allows the app to read assignments and their grades for all users | -|EduAssignments.ReadWrite.All | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | - - - -#### App+User Context - -| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | -|:-----------------|:-------------------|:----------|--------------|------------| -|EduAssignments.ReadBasic| Read a user's view of class assignments without grades | Allows the app to read assignments without grades on behalf of the user | View your assignments without grades | Allows the app to view your assignments on your behalf without seeing grades | -|EduAssignments.ReadWriteBasic|Read and write a user's view of class assignments without grades|Allows the app to read and write assignments without grades on behalf of the user|View and modify your assignments without grades|Allows the app to view and modify your assignments on your behalf without seeing grades| -|EduAssignments.Read|Read a user's view of class assignments and their grades|Allows the app to read assignments and their grades on behalf of the user|View your assignments and grades|Allows the app to view your assignments on your behalf including grades| -|EduAssignments.ReadWrite|Read and write a user's view of class assignments and their grades|Allows the app to read and write assignments and their grades on behalf of the user|View and modify your assignments and grades|Allows the app to view and modify your assignments on your behalf including grades| - - - ### Understanding assignment Resources - -Assignment APIs provide the following key resources: - -- [assignment](./resources/educationassignment.md) - **Assignment** is the core object of the Assignments API and owned by the class. -- [Submission](.resources/educationsubmission.md) - **Submission** objects are owned by an assignment. They represents the resources that an individual (or group) submit for an assignment and associated grade/feedback. -- [Resource](resources/educationresource.md) - A resource is associated with an **Assignment** and/or **Submission** and represents the learning object that is being assigned or submitted. - - ### Overview of APIs -Assignments endpoint in EDU Graph provide the following APIs. - -- [Create Assignment](./api/educationclass_post_assignments.md) -- [Publish Assignment](./api/educationassignment_publish.md) -- [Create Assignment Resource](./api/educationassignment_post_resources.md) -- [Create Submission Resource](./api/educationsubmission_post_resources.md) -- [Submit Assignment](./api/educationsubmission_submit.md) -- [Release Grades to student](./api/educationsubmission_release.md) -- [Get assignment Details](./api/educationuser_list_assignments.md) - -Check out the complete set of APIs [here](./api). - - -### Building your first app - -Read the [Microsoft Graph documentation](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using assignment APIs. - - The [EDUGraphAPI - Office 365 Education Code Sample](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) is available from our _GitHub_ repository. Clone the repository to learn about the end to end sample built on Assignments APIs. - diff --git a/EDUGraphAPIs/Rostering/GettingStarted.md b/EDUGraphAPIs/Rostering/GettingStarted.md deleted file mode 100644 index fabf1d44..00000000 --- a/EDUGraphAPIs/Rostering/GettingStarted.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft Education Graph Rostering API : Getting Started - - This document provides information for getting started with Rostering API. - - ### 1. Understanding Scopes - - The Rostering Service adds a few new Scopes to the Microsoft Graph. These Scopes need to be used to access Roster information. Scopes are the way users or administrators decide what information an application (or more practically the vendor who creates an application) has access to. In app+user scenarios, the intersection of the user’s permissions and the application’s scopes define the data that the running app can work with. - -#### App-Only Context - -| Role | Display Name |Description| -|:-----------------|:-------------------|:----------| -|EduRostering.ReadBasic.All| Read a limited subset of the organization's roster. |Allows the app to read a limited subset of both the structure of schools and classes in an organization's roster and education-specific information about all users.| -|EduRostering.Read.All | Read the organization's roster. | Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read. | -|EduRostering.ReadWrite.All| Read and write the organization's roster. | Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written. | - - -#### App+User Context - -| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | -|:-----------------|:-------------------|:----------|--------------|------------| -EduRostering.ReadBasic| Read a limited subset of a user's view of the roster | Allows the app to read a limited subset of the data from the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user. |View a limited subset of your school, class and user information. |Allows the app to view a limited subset of the information about schools and classes in your organization and education-related information about you and other users on your behalf. | - - - ### 2. Understanding Education Roster Resources - -assignment APIs provide the following key resources: - -- [School](resources/educationschool.md) - A resource that represents the school. -- [Class](./resources/educationclass.md) - Represents a class within a school. -- [Term](resources/educationterm.md) - Represents a designated portion of the academic year. -- [Teacher ](resources/educationteacher.md) - Represents a users with primary Role 'Teacher'. -- [Student](resources/educationstudent.md) - Represents a users with primary Role 'student'. - - ### 3. Overview of APIs -assignments endpoint in EDU Graph provide the following APIs. - -- [Get Students and Teachers for a Class](./api/educationclass_list_members.md) -- [List Schools I teach](./api/educationclass_list_schools.md) -- [List Teachers for a class](./api/educationclass_list_teachers.md) -- [Add Members to a Class](./api/educationclass_post_members.md) -- [Get All Classes](./api/educationroot_list_classes.md ) -- [List All Schools](./api/educationroot_list_schools.md) -- [Get Classes in a School](./api/educationschool_list_classes.md) -- [Get users in a school](./api/educationschool_list_users.md) -- [Add Classes to a School](./api/educationschool_post_classes.md) -- [List of Classes for a user](./api/educationuser_list_classes.md) -- [List of Schools for a user](./api/educationuser_list_schools.md) - - -Check out the complete set of APIs [here](./api). - - -### 4. Building your first app - -Follow the Microsoft Graph documentation [here](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using Rostering APIs. - -Getting Started Sample : Browse [here](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) to checkout the end to end sample built on Rostering APIs. - From 08148d89f8db1ae6b971597fdbad3f9594a4935c Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 14:44:55 -0800 Subject: [PATCH 45/87] Update heading. --- EDUGraphAPIs/permissions_reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/permissions_reference.md b/EDUGraphAPIs/permissions_reference.md index be480868..8e6618a3 100644 --- a/EDUGraphAPIs/permissions_reference.md +++ b/EDUGraphAPIs/permissions_reference.md @@ -255,7 +255,7 @@ For more complex scenarios involving multiple permissions, see [Permission scena --- -## Education Graph permissions +## Education permissions #### Delegated permissions From a7f64a51cace50321e926501d51cff9ce685b574 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 14:48:59 -0800 Subject: [PATCH 46/87] Updated authorization section. --- EDUGraphAPIs/education-overview.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 65d85e21..c06afd1b 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -16,8 +16,25 @@ The education APIs include two new resources, **rostering** and [educationAssign ## Authorization -To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. -For more information about permissions for education APIs, see [Permissions](EDUGraphAPIs/permissions_reference.md). +To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information about permissions for education APIs, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). + +### App permissions to enable school IT admins to consent + +To deploy apps that are integrated with the Education APIs in Microsoft Graph, school IT admins must first grant consent to the permissions requested by the app. This consent has to be granted only once, unless the permissions change. After the admin consents, the app is provisioned for all users in the tenant. + +To trigger a consent dialog box, use the following REST call. + +``` +GET https://login.microsoftonline.com/{tenant}/adminconsent? +client_id={clientId}&state=12345&redirect_uri={redirectUrl} +``` + +|Parameter|Description| +|:--------|:----------| +|Tenant|Tenant ID of the school.| +|clientId|Client ID of the app.| +|redirectUrl|App redirect URL.| + ## Rostering From 10b7ee40ecb103ef0cb14d3fbda4e264364434ab Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 13 Nov 2017 14:55:42 -0800 Subject: [PATCH 47/87] Made text more concise. --- EDUGraphAPIs/education-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index c06afd1b..3e7f90e7 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -16,7 +16,7 @@ The education APIs include two new resources, **rostering** and [educationAssign ## Authorization -To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information about permissions for education APIs, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). +To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). ### App permissions to enable school IT admins to consent From 720a5ab7b257ba1c1e735fb110fe7c8e9398bd1b Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 14 Nov 2017 09:32:06 -0800 Subject: [PATCH 48/87] Edits. --- .../api/educationassignment_list_resources.md | 4 ++-- EDUGraphAPIs/Rostering/api/educationclass_delete.md | 9 +++++---- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index fd6651f2..7202ca6c 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -27,7 +27,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. ## Example ##### Request The following is an example of the request. @@ -41,7 +41,7 @@ GET https://graph.microsoft.com/beta/education/classes//assignments//res ##### Response The following is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ## Assignments You can use the assignment-related education APIs to integrate with assignments in Microsoft Teams. Microsoft Teams in Office 365 for Education is based on the same education APIs, and provides a use case for what you can do with the APIs. Your app can use these APIs to interact with assignments throughout the assignment lifecycle. From 55e939309e7ce5f1bb4eb2fee7a97ca0ad1a5d43 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 14 Nov 2017 13:56:40 -0800 Subject: [PATCH 50/87] Added boilerplate. --- EDUGraphAPIs/Assignments/api/educationassignment_publish.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index e1937f85..5aadf709 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -23,6 +23,7 @@ POST /education/classes//assignments//publish | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. @@ -59,4 +60,4 @@ HTTP/1.1 204 No Content "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From a954428d3d6e8952cae14bb57764031371e27705 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 14 Nov 2017 14:38:18 -0800 Subject: [PATCH 51/87] Edit pass. --- .../api/educationclass_delete_members.md | 12 +++++----- .../api/educationclass_delete_teachers.md | 12 +++++----- .../Rostering/api/educationclass_get.md | 9 +++++--- .../api/educationclass_list_members.md | 11 ++++++---- .../api/educationclass_list_teachers.md | 11 ++++++---- .../api/educationclass_post_members.md | 17 ++++++++------ .../api/educationclass_post_teachers.md | 17 ++++++++------ .../Rostering/api/educationclass_update.md | 22 +++++++++++-------- .../api/educationroot_list_classes.md | 9 +++++--- .../api/educationroot_list_schools.md | 11 ++++++---- 10 files changed, 78 insertions(+), 53 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 3917f817..0d75a43f 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,6 +1,6 @@ -# Delete educationUser from educationClass +# Delete educationUser (member) -Delete a member from a Class. +Delete a member from a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and empty response body. +If successful, this method returns a `204 No Content` response code and an empty response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. +|classCode|String| Class code used by the school.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was creaeted. Possible values are: `sis`, `manual`, `enum_sentinel`.| +|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `enum_sentinel`.| ## Response -If successful, this method returns a `200 OK` response code and updated [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -23,15 +25,15 @@ POST /education/users | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -26,7 +28,7 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request @@ -39,7 +41,7 @@ Here is an example of the request. DELETE https://graph.microsoft.com/beta/education/users/ ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -28,10 +30,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + >**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + + ```http -DELETE /education/classes/ +DELETE /education/classes/{id} ``` ## Request headers diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 0d75a43f..724d29aa 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/classes//members/{userId}/$ref +DELETE /education/classes/{id}/members/{userId}/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index 1c3c1edc..c709228f 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/classes//teachers/{userId}/$ref +DELETE /education/classes/{id}/teachers/{userId}/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationclass_get.md b/EDUGraphAPIs/Rostering/api/educationclass_get.md index 954d20c7..b1754823 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_get.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/ +GET /education/classes/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md index 6088de40..7461e9f2 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//members +GET /education/classes/{id}/members ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 55f637c8..62b7ff5e 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//schools +GET /education/classes/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 05912f1d..55d1e588 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//teachers +GET /education/classes/{id}/teachers ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md index d051d494..1ba3240a 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//members/$ref +POST /education/classes/{id}/members/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md index f69b4149..d9fe81b0 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//teachers/$ref +POST /education/classes/{id}/teachers/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationclass_update.md b/EDUGraphAPIs/Rostering/api/educationclass_update.md index 35d43b7f..4b79baa7 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_update.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes/ +PATCH /education/classes/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete.md b/EDUGraphAPIs/Rostering/api/educationschool_delete.md index 168e8c02..e3c3c5f5 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/schools/ +DELETE /education/schools/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md index b4139e21..221a56dd 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/schools//classes/{classId}/$ref +DELETE /education/schools/{id}/classes/{classId}/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md index 4dacd20f..5deeddeb 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md @@ -36,7 +36,7 @@ Here is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -DELETE https://graph.microsoft.com/beta/education/schools//users/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/{id}/users/{userId}/$ref ``` ##### Response diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md index 482284cd..561178db 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/schools//classes +GET /education/schools/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md index 78dee84a..a8c17eb6 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/schools//users +GET /education/schools/{id}/users ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md index 946c7a8e..0c88fd06 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/schools//classes/$ref +POST /education/schools/{id}/classes/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md index 124f77c0..19e57a37 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/schools//users/$ref +POST /education/schools/{id}/users/$ref ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationschool_update.md b/EDUGraphAPIs/Rostering/api/educationschool_update.md index a0180594..b077d57a 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_update.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/schools/ +PATCH /education/schools/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationuser_delete.md b/EDUGraphAPIs/Rostering/api/educationuser_delete.md index 4b6c6ae6..46adb8ee 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_delete.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/users/ +DELETE /education/users/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Rostering/api/educationuser_get.md b/EDUGraphAPIs/Rostering/api/educationuser_get.md index 1bb604eb..41a62d44 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_get.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me -GET /education/users/ +GET /education/users/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md index 6a29a78f..db881275 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md @@ -17,7 +17,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/classes -GET /education/users//classes +GET /education/users/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md index 62d06bd1..0d324ed6 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/schools -GET /education/users//schools +GET /education/users/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_update.md b/EDUGraphAPIs/Rostering/api/educationuser_update.md index 0851ea1a..f49a6453 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_update.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ```http PATCH /education/me -PATCH /education/users/ +PATCH /education/users/{id} ``` ## Request headers | Header | Value | From a4ea2cc2461a6245ba7800c42a4c534b11465363 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 15 Nov 2017 12:12:42 -0800 Subject: [PATCH 59/87] Replace angle brackets. --- EDUGraphAPIs/Assignments/api/educationassignment_delete.md | 2 +- EDUGraphAPIs/Assignments/api/educationassignment_get.md | 2 +- .../api/educationassignment_getResourcesFolderUrl.md | 2 +- .../Assignments/api/educationassignment_list_resources.md | 2 +- .../Assignments/api/educationassignment_list_submissions.md | 2 +- .../Assignments/api/educationassignment_post_resources.md | 2 +- EDUGraphAPIs/Assignments/api/educationassignment_publish.md | 2 +- EDUGraphAPIs/Assignments/api/educationassignment_update.md | 2 +- .../Assignments/api/educationassignmentresource_delete.md | 2 +- EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md | 2 +- .../Assignments/api/educationassignmentresource_update.md | 2 +- EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md | 2 +- EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmission_get.md | 2 +- .../Assignments/api/educationsubmission_list_resources.md | 2 +- .../api/educationsubmission_list_submittedresources.md | 2 +- .../Assignments/api/educationsubmission_post_resources.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmission_recall.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmission_release.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmission_submit.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmission_update.md | 2 +- .../Assignments/api/educationsubmissionresource_delete.md | 2 +- EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md | 2 +- .../Assignments/api/educationsubmittedsubmissionresource_get.md | 2 +- EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md | 2 +- 25 files changed, 25 insertions(+), 25 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index f9c32cd5..542fd23f 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -40,7 +40,7 @@ The following is an example of the request. }--> ```http -DELETE https://graph.microsoft.com/beta/education/classes//assignments/ +DELETE https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id} ``` ##### Response The following is an example of the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_get.md b/EDUGraphAPIs/Assignments/api/educationassignment_get.md index 6cbbe132..a22cc03e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_get.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments/ +GET /education/classes/{id}/assignments/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index 1cd94e7d..c45180d0 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//getResourcesFolderUrl +POST /education/classes/{id}/assignments/{id}/getResourcesFolderUrl ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index 7202ca6c..58a180fd 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//resources +GET /education/classes/{id}/assignments/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md index c03504b3..e19550ea 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions +GET /education/classes/{id}/assignments/{id}/submissions ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md index 3c0ac273..635d62b8 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//resources +POST /education/classes/{id}/assignments/{id}/resources ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index 5aadf709..5509ff50 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//publish +POST /education/classes/{id}/assignments/{id}/publish ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index 0581d476..9b30b31e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments/ +PATCH /education/classes/{id}/assignments/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md index 42fadcf5..289c4f47 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments//resources/ +DELETE /educationClasses/assignments/{id}/resources/{id} ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md index 71a73e67..383becda 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md @@ -13,7 +13,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//resources/ +GET /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md index 6ef084b0..8f4fb47f 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments//resources/ +PATCH /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index 4226d637..37c0fbf2 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments +GET /education/classes/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index 9bf5fca9..a789c7cb 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments +POST /education/classes/{id}/assignments ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md index 6316d80f..7cf1a726 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions/ +GET /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md index 1d0679a2..1d8d1b92 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /educationClasses/assignments//submissions//resources +GET /educationClasses/assignments/{id}/submissions/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md index edb83600..0e1b04b2 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions//submittedResources +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md index 36138167..fe564b53 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//resources +POST /education/classes/{id}/assignments/{id}/submissions/{id}/resources ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md index ccefe6d5..b05f5658 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//recall +POST /education/classes//assignments/{id}/submissions/{id}/recall ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md index 1726b47e..f6784d4e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//release +POST /education/classes/{id}/assignments/{id}/submissions/{id}/release ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md index 9189d3a2..93ba33c4 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//submit +POST /education/classes/{id}/assignments/{id}/submissions/{id}/submit ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md index 38280323..563382e0 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments//submissions/ +PATCH /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md index 92df6781..55a2538e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments//submissions//resources/ +DELETE /educationClasses/assignments/{id}/submissions/{id}/resources/{id} ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md index bc66c096..4a71d435 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /educationn/classes//assignments//submissions//resources/ +GET /educationn/classes/{id}/assignments/{id}/submissions/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md index 20db7b1c..7ff9fd75 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions//submittedResources/ +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 90449782..723af8c4 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/assignments/ -GET /education/users//assignments +GET /education/users/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. From 7515a70b6f577ae4f0809cbf9d0c5144917c475f Mon Sep 17 00:00:00 2001 From: John Austin Date: Wed, 15 Nov 2017 13:14:50 -0800 Subject: [PATCH 60/87] first edits --- EDUGraphAPIs/Assignments/GettingStarted.md | 59 ++++++++++++ .../api/educationassignment_delete.md | 8 +- .../api/educationassignment_get.md | 4 +- ...ucationassignment_getResourcesFolderUrl.md | 2 +- .../api/educationassignment_list_resources.md | 6 +- .../educationassignment_list_submissions.md | 2 +- .../api/educationassignment_post_resources.md | 7 +- .../api/educationassignment_publish.md | 5 +- .../api/educationassignment_update.md | 2 +- .../api/educationassignmentresource_delete.md | 3 +- .../api/educationassignmentresource_get.md | 2 +- .../api/educationassignmentresource_update.md | 2 +- .../api/educationclass_list_assignments.md | 2 +- .../api/educationclass_post_assignments.md | 2 +- .../api/educationsubmission_get.md | 2 +- .../api/educationsubmission_list_resources.md | 2 +- ...ationsubmission_list_submittedresources.md | 2 +- .../api/educationsubmission_post_resources.md | 2 +- .../api/educationsubmission_recall.md | 2 +- .../api/educationsubmission_release.md | 2 +- .../api/educationsubmission_submit.md | 2 +- .../api/educationsubmission_update.md | 2 +- .../api/educationsubmissionresource_delete.md | 4 +- .../api/educationsubmissionresource_get.md | 2 +- ...ducationsubmittedsubmissionresource_get.md | 2 +- .../api/educationuser_list_assignments.md | 2 +- .../educationassignmentclassrecipient.md | 2 +- .../resources/educationassignmentgrade.md | 4 +- EDUGraphAPIs/Rostering/GettingStarted.md | 59 ++++++++++++ .../Rostering/api/educationclass_delete.md | 13 ++- .../api/educationclass_delete_members.md | 15 +-- .../api/educationclass_delete_teachers.md | 12 +-- .../Rostering/api/educationclass_get.md | 35 ++++--- .../api/educationclass_list_members.md | 13 +-- .../api/educationclass_list_schools.md | 2 +- .../api/educationclass_list_teachers.md | 13 +-- .../api/educationclass_post_members.md | 18 ++-- .../api/educationclass_post_teachers.md | 21 ++--- .../Rostering/api/educationclass_update.md | 24 ++--- .../api/educationroot_list_classes.md | 9 +- .../api/educationroot_list_schools.md | 11 +-- .../Rostering/api/educationroot_list_users.md | 11 +-- .../api/educationroot_post_classes.md | 17 ++-- .../api/educationroot_post_schools.md | 13 +-- .../Rostering/api/educationroot_post_users.md | 15 +-- .../Rostering/api/educationschool_delete.md | 9 +- .../api/educationschool_delete_classes.md | 13 ++- .../api/educationschool_delete_users.md | 10 +- .../Rostering/api/educationschool_get.md | 9 +- .../api/educationschool_list_classes.md | 11 +-- .../api/educationschool_list_users.md | 11 +-- .../api/educationschool_post_classes.md | 17 ++-- .../api/educationschool_post_users.md | 17 ++-- .../Rostering/api/educationschool_update.md | 13 +-- .../Rostering/api/educationuser_delete.md | 8 +- .../Rostering/api/educationuser_get.md | 11 +-- .../api/educationuser_list_classes.md | 15 +-- .../api/educationuser_list_schools.md | 11 +-- .../Rostering/api/educationuser_update.md | 6 +- .../Rostering/resources/educationstudent.md | 6 +- .../Rostering/resources/educationuser.md | 4 +- EDUGraphAPIs/education-overview.md | 91 ++++++------------- EDUGraphAPIs/permissions_reference.md | 2 +- 63 files changed, 360 insertions(+), 343 deletions(-) create mode 100644 EDUGraphAPIs/Assignments/GettingStarted.md create mode 100644 EDUGraphAPIs/Rostering/GettingStarted.md diff --git a/EDUGraphAPIs/Assignments/GettingStarted.md b/EDUGraphAPIs/Assignments/GettingStarted.md new file mode 100644 index 00000000..3ac71428 --- /dev/null +++ b/EDUGraphAPIs/Assignments/GettingStarted.md @@ -0,0 +1,59 @@ +# Microsoft Education Graph Assignments API : Getting Started + + This document provides information for getting started with assignments API. + + ### Understanding Scopes + + The Assignment Service adds a few new scopes to the **Microsoft Graph**. These scopes are used to access Assignment information. The scope applies to all the **Assignment** objects including [Assignment](./resources/educationassignment.md), [Resource](./resources/educationresource.md), and [Submission](./resources/educationsubmission.md). With an App+User Context, the API will only return objects that the user has access to. The "Basic" scopes work the same as the non-basic equivalent scopes, however grade information will not be returned in the Submission objects for "Basic" scopes. + + >**Note:** Students can only access their own Submission. + +#### App-Only Context + +| Role (scope) | Display Name |Description| +|:-----------------|:-------------------|:----------| +|EduAssignments.ReadBasic.All| Read class assignments without grades|Allows the app to read assignments without grades for all users| +|EduAssignments.ReadWriteBasic.All | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| +|EduAssignments.Read.All| Read class assignments with grades | Allows the app to read assignments and their grades for all users | +|EduAssignments.ReadWrite.All | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | + + + +#### App+User Context + +| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | +|:-----------------|:-------------------|:----------|--------------|------------| +|EduAssignments.ReadBasic| Read a user's view of class assignments without grades | Allows the app to read assignments without grades on behalf of the user | View your assignments without grades | Allows the app to view your assignments on your behalf without seeing grades | +|EduAssignments.ReadWriteBasic|Read and write a user's view of class assignments without grades|Allows the app to read and write assignments without grades on behalf of the user|View and modify your assignments without grades|Allows the app to view and modify your assignments on your behalf without seeing grades| +|EduAssignments.Read|Read a user's view of class assignments and their grades|Allows the app to read assignments and their grades on behalf of the user|View your assignments and grades|Allows the app to view your assignments on your behalf including grades| +|EduAssignments.ReadWrite|Read and write a user's view of class assignments and their grades|Allows the app to read and write assignments and their grades on behalf of the user|View and modify your assignments and grades|Allows the app to view and modify your assignments on your behalf including grades| + + + ### Understanding assignment Resources + +Assignment APIs provide the following key resources: + +- [assignment](./resources/educationassignment.md) - **Assignment** is the core object of the Assignments API and owned by the class. +- [Submission](.resources/educationsubmission.md) - **Submission** objects are owned by an assignment. They represents the resources that an individual (or group) submit for an assignment and associated grade/feedback. +- [Resource](resources/educationresource.md) - A resource is associated with an **Assignment** and/or **Submission** and represents the learning object that is being assigned or submitted. + + ### Overview of APIs +Assignments endpoint in EDU Graph provide the following APIs. + +- [Create Assignment](./api/educationclass_post_assignments.md) +- [Publish Assignment](./api/educationassignment_publish.md) +- [Create Assignment Resource](./api/educationassignment_post_resources.md) +- [Create Submission Resource](./api/educationsubmission_post_resources.md) +- [Submit Assignment](./api/educationsubmission_submit.md) +- [Release Grades to student](./api/educationsubmission_release.md) +- [Get assignment Details](./api/educationuser_list_assignments.md) + +Check out the complete set of APIs [here](./api). + + +### Building your first app + +Read the [Microsoft Graph documentation](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using assignment APIs. + + The [EDUGraphAPI - Office 365 Education Code Sample](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) is available from our _GitHub_ repository. Clone the repository to learn about the end to end sample built on Assignments APIs. + diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index 542fd23f..645e807d 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -31,7 +31,7 @@ Do not supply a request body for this method. If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example -##### Request +### Request The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id} +DELETE https://graph.microsoft.com/beta/education/classes//assignments/ ``` -##### Response +### Response The following is an example of the response. + + ```http -GET /education/classes/{id}/assignments/{id} +GET /education/classes//assignments/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -29,7 +29,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `200 OK` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request The following is an example of the request. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index c45180d0..1cd94e7d 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/getResourcesFolderUrl +POST /education/classes//assignments//getResourcesFolderUrl ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index 58a180fd..fd6651f2 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/assignments/{id}/resources +GET /education/classes//assignments//resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,7 +27,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. ## Example ##### Request The following is an example of the request. @@ -41,7 +41,7 @@ GET https://graph.microsoft.com/beta/education/classes//assignments//res ##### Response The following is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. ```http -GET /education/classes/{id}/assignments/{id}/submissions +GET /education/classes//assignments//submissions ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md index 635d62b8..3efe1830 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/resources +POST /education/classes//assignments//resources ``` ## Request headers | Header | Value | @@ -57,12 +57,12 @@ The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. -```http +```http HTTP/1.1 201 Created Content-type: application/json @@ -78,7 +78,7 @@ Content-length: 842 } } - +``` -``` \ No newline at end of file diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index 5509ff50..e1937f85 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/publish +POST /education/classes//assignments//publish ``` ## Request headers @@ -23,7 +23,6 @@ POST /education/classes/{id}/assignments/{id}/publish | Authorization | Bearer {token}. Required. | ## Request body -Do not supply a request body for this method. ## Response If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. @@ -60,4 +59,4 @@ HTTP/1.1 204 No Content "keywords": "", "section": "documentation", "tocPath": "" -}--> +}--> \ No newline at end of file diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index 9b30b31e..0581d476 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes/{id}/assignments/{id} +PATCH /education/classes//assignments/ ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md index 289c4f47..47e6c61e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments/{id}/resources/{id} +DELETE /educationClasses/assignments//resources/ ``` ## Request headers @@ -42,6 +42,7 @@ DELETE https://graph.microsoft.com/beta/education/classes//assignments// ##### Response The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. ```http -GET /education/classes/{id}/assignments/{id}/resources/{id} +GET /education/classes//assignments//resources/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md index 8f4fb47f..6ef084b0 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes/{id}/assignments/{id}/resources/{id} +PATCH /education/classes//assignments//resources/ ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index 37c0fbf2..4226d637 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/assignments +GET /education/classes//assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index a789c7cb..9bf5fca9 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments +POST /education/classes//assignments ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md index 7cf1a726..6316d80f 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/assignments/{id}/submissions/{id} +GET /education/classes//assignments//submissions/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md index 1d8d1b92..1d0679a2 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /educationClasses/assignments/{id}/submissions/{id}/resources +GET /educationClasses/assignments//submissions//resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md index 0e1b04b2..edb83600 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources +GET /education/classes//assignments//submissions//submittedResources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md index fe564b53..36138167 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/submissions/{id}/resources +POST /education/classes//assignments//submissions//resources ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md index b05f5658..ccefe6d5 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments/{id}/submissions/{id}/recall +POST /education/classes//assignments//submissions//recall ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md index f6784d4e..1726b47e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/submissions/{id}/release +POST /education/classes//assignments//submissions//release ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md index 93ba33c4..9189d3a2 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes/{id}/assignments/{id}/submissions/{id}/submit +POST /education/classes//assignments//submissions//submit ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md index 563382e0..38280323 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes/{id}/assignments/{id}/submissions/{id} +PATCH /education/classes//assignments//submissions/ ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md index 55a2538e..2a0dd732 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments/{id}/submissions/{id}/resources/{id} +DELETE /educationClasses/assignments//submissions//resources/ ``` ## Request headers @@ -42,6 +42,8 @@ DELETE https://graph.microsoft.com/beta/education/classes//assignments// ##### Response The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +> ```http -GET /educationn/classes/{id}/assignments/{id}/submissions/{id}/resources/{id} +GET /educationn/classes//assignments//submissions//resources/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md index 7ff9fd75..20db7b1c 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources/{id} +GET /education/classes//assignments//submissions//submittedResources/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 723af8c4..90449782 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/assignments/ -GET /education/users/{id}/assignments +GET /education/users//assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md index e5b5ca60..fabb5bb1 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md @@ -1,6 +1,6 @@ # educationAssignmentClassRecipient resource type -Used inside the [assignment.assignTo](educationassignment.md) property. When set to class recipient, every student in the class will +A type assignment recipient and one of the values of the [assignment.assignTo](educationassignment.md) property. When set to class recipient, every student in the class will receive a submission object when the assignment is published. This resource is a subclass of [educationAssignmentRecipient](educationassignmentrecipient.md). diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md index bd518432..2bdfc051 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md @@ -1,7 +1,7 @@ # educationAssignmentGrade resource type -Represents the **Grade** object on a Submission. This is an abstract type that will never be instantiated; however, all types of grading (points, pass/fail, and so on) are subclasses of this -resource type. This object also tracks who is doing the grading. This is used in the **submission.grade** property. +Represents the **Grade** object on a Submission. This is an abstract type that will never be instantiated; however, all grading schemes (points, pass/fail, and so on) are subclasses of this +resource type. This object also the person assessing the assignment for a grade. This is used in the **submission.grade** property. ## Properties diff --git a/EDUGraphAPIs/Rostering/GettingStarted.md b/EDUGraphAPIs/Rostering/GettingStarted.md new file mode 100644 index 00000000..fabf1d44 --- /dev/null +++ b/EDUGraphAPIs/Rostering/GettingStarted.md @@ -0,0 +1,59 @@ +# Microsoft Education Graph Rostering API : Getting Started + + This document provides information for getting started with Rostering API. + + ### 1. Understanding Scopes + + The Rostering Service adds a few new Scopes to the Microsoft Graph. These Scopes need to be used to access Roster information. Scopes are the way users or administrators decide what information an application (or more practically the vendor who creates an application) has access to. In app+user scenarios, the intersection of the user’s permissions and the application’s scopes define the data that the running app can work with. + +#### App-Only Context + +| Role | Display Name |Description| +|:-----------------|:-------------------|:----------| +|EduRostering.ReadBasic.All| Read a limited subset of the organization's roster. |Allows the app to read a limited subset of both the structure of schools and classes in an organization's roster and education-specific information about all users.| +|EduRostering.Read.All | Read the organization's roster. | Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read. | +|EduRostering.ReadWrite.All| Read and write the organization's roster. | Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written. | + + +#### App+User Context + +| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | +|:-----------------|:-------------------|:----------|--------------|------------| +EduRostering.ReadBasic| Read a limited subset of a user's view of the roster | Allows the app to read a limited subset of the data from the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user. |View a limited subset of your school, class and user information. |Allows the app to view a limited subset of the information about schools and classes in your organization and education-related information about you and other users on your behalf. | + + + ### 2. Understanding Education Roster Resources + +assignment APIs provide the following key resources: + +- [School](resources/educationschool.md) - A resource that represents the school. +- [Class](./resources/educationclass.md) - Represents a class within a school. +- [Term](resources/educationterm.md) - Represents a designated portion of the academic year. +- [Teacher ](resources/educationteacher.md) - Represents a users with primary Role 'Teacher'. +- [Student](resources/educationstudent.md) - Represents a users with primary Role 'student'. + + ### 3. Overview of APIs +assignments endpoint in EDU Graph provide the following APIs. + +- [Get Students and Teachers for a Class](./api/educationclass_list_members.md) +- [List Schools I teach](./api/educationclass_list_schools.md) +- [List Teachers for a class](./api/educationclass_list_teachers.md) +- [Add Members to a Class](./api/educationclass_post_members.md) +- [Get All Classes](./api/educationroot_list_classes.md ) +- [List All Schools](./api/educationroot_list_schools.md) +- [Get Classes in a School](./api/educationschool_list_classes.md) +- [Get users in a school](./api/educationschool_list_users.md) +- [Add Classes to a School](./api/educationschool_post_classes.md) +- [List of Classes for a user](./api/educationuser_list_classes.md) +- [List of Schools for a user](./api/educationuser_list_schools.md) + + +Check out the complete set of APIs [here](./api). + + +### 4. Building your first app + +Follow the Microsoft Graph documentation [here](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using Rostering APIs. + +Getting Started Sample : Browse [here](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) to checkout the end to end sample built on Rostering APIs. + diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete.md b/EDUGraphAPIs/Rostering/api/educationclass_delete.md index f1876bac..bd33a0de 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete.md @@ -1,6 +1,6 @@ # Delete educationClass -Delete a class. Because a class is also a universal group, deleting a class deletes the group. +Delete a class. A class is also a universal group so the group is deleted as well. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/classes/{id} +DELETE /education/classes/ ``` ## Request headers @@ -27,21 +27,20 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes/ +DELETE https://graph.microsoft.com/beta/education/classes/11022 ``` ##### Response -The following is an example of the response. - +Here is an example of the response. ```http -DELETE /education/classes/{id}/members/{userId}/$ref +DELETE /education/classes//members/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,21 +26,22 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code and an empty response body. +If successful, this method returns `204, No Content` response code and empty response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/classes//members/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008/$ref ``` ##### Response -The following is an example of the response. +Here is an example of the response. + ```http -DELETE /education/classes/{id}/teachers/{userId}/$ref +DELETE /education/classes//teachers/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code and an empty response body. +If successful, this method returns `204, No Content` response code and empty response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -GET /education/classes/{id} +GET /education/classes/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,7 +27,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and an [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request Here is an example of the request. @@ -36,12 +36,12 @@ Here is an example of the request. "name": "get_educationclass" }--> ```http -GET https://graph.microsoft.com/beta/education/classes/ +GET https://graph.microsoft.com/beta/education/classes/11023 ``` ##### Response -The following is an example of the response. +Here is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +>Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http -GET /education/classes/{id}/members +GET /education/classes//members ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -GET /education/classes/{id}/schools +GET /education/classes//schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 55d1e588..1d012d2e 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -1,6 +1,6 @@ # List teachers -Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. +Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes/{id}/teachers +GET /education/classes//teachers ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -POST /education/classes/{id}/members/$ref +POST /education/classes//members/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/classes/{id}/members/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -POST /education/classes/{id}/teachers/$ref +POST /education/classes//teachers/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/classes/{id}/teachers/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. - ->**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. - +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http -PATCH /education/classes/{id} +PATCH /education/classes/ ``` ## Request headers | Header | Value | @@ -23,24 +23,23 @@ PATCH /education/classes/{id} | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|description|String| Description of the class.| -|displayName|String| Name of the class.| -|mailNickname|String| Email alias for sending email to all users if that feature is enabled. | - -|classCode|String| Class code used by the school.| +|description|String| Description of the class| +|displayName|String| Name of the Class| +|mailNickname|String| Mail name for sending email to all users if this is enabled. | +|classCode|String| Class Code used by the school.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `enum_sentinel`.| +|externalSource|string| How this class was creaeted. Possible values are: `sis`, `manual`, `enum_sentinel`.| ## Response -If successful, this method returns a `200 OK` response code and an updated [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -25,15 +23,15 @@ POST /education/users | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns `201, Created` response code and [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -DELETE /education/schools/{id} +DELETE /education/schools/ ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -DELETE /education/schools/{id}/classes/{classId}/$ref +DELETE /education/schools//classes/{classId}/$ref ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code and a response body. +If successful, this method returns `204, No Content` response code and a response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/schools/{id}/users/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools//users/{userId}/$ref ``` - +In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. ##### Response -The following is an example of the response. +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http -GET /education/schools/{id}/classes +GET /education/schools//classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -GET /education/schools/{id}/users +GET /education/schools//users ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http -POST /education/schools/{id}/classes/$ref +POST /education/schools//classes/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/schools/{id}/classes/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of an [educationClass](../resources/educationclass.md) object. +In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. ## Response -If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. - +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http -POST /education/schools/{id}/users/$ref +POST /education/schools//users/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/schools/{id}/users/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. - +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http -PATCH /education/schools/{id} +PATCH /education/schools/ ``` ## Request headers | Header | Value | @@ -23,7 +23,7 @@ PATCH /education/schools/{id} | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| @@ -42,10 +42,10 @@ In the request body, supply the values for relevant fields that should be update |createdBy|[identitySet](identityset.md)|Entity who created the school.| ## Response -If successful, this method returns a `200 OK` response code and an updated [educationSchool](../resources/educationschool.md) object in the response body. +If successful, this method returns a `200 OK` response code and updated [educationSchool](../resources/educationschool.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -16,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/users/{id} +DELETE /education/users/ ``` ## Request headers | Header | Value | @@ -28,7 +26,7 @@ Do not supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. +If successful, this method returns `204, No Content` response code. It does not return anything in the response body. ## Example ##### Request @@ -41,7 +39,7 @@ Here is an example of the request. DELETE https://graph.microsoft.com/beta/education/users/ ``` ##### Response -The following is an example of the response. +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ```http GET /education/me -GET /education/users/{id} +GET /education/users/ ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and an [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `200 OK` response code and [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. +Retrieve a list of class objects. Delegated tokens can only see information on themselves. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -17,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/classes -GET /education/users/{id}/classes +GET /education/users//classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -30,10 +28,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http GET /education/me/schools -GET /education/users/{id}/schools +GET /education/users//schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -The following is an example of the request. +Here is an example of the request. ```http PATCH /education/me -PATCH /education/users/{id} +PATCH /education/users/ ``` ## Request headers | Header | Value | @@ -23,7 +23,7 @@ PATCH /education/users/{id} | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| diff --git a/EDUGraphAPIs/Rostering/resources/educationstudent.md b/EDUGraphAPIs/Rostering/resources/educationstudent.md index 08e67684..07ac3396 100644 --- a/EDUGraphAPIs/Rostering/resources/educationstudent.md +++ b/EDUGraphAPIs/Rostering/resources/educationstudent.md @@ -1,15 +1,15 @@ # educationStudent resource type -Additional information added to an [educationUser](educationuser.md) that is present when the primaryRole of a user is `student`. +Additional information added to an [educationUser](educationuser.md) that is present when the `primaryRole` of a user is `student`. ## Properties | Property | Type |Description| |:---------------|:--------|:----------| -|birthDate|Date| Birthdate of the student.| +|birthDate|Date| Birth date of the student.| |externalId|String| ID of the student in the source system.| |gender|`educationGender enumeration`| Possible values are: `female`, `male`, `other`, `unkownFutureValue`.| |grade|String|Current grade level of the student.| -|graduationYear|String| Year the child is graduating from the school.| +|graduationYear|String| Year the student is graduating from the school.| |studentNumber|String| Student Number.| ## JSON representation diff --git a/EDUGraphAPIs/Rostering/resources/educationuser.md b/EDUGraphAPIs/Rostering/resources/educationuser.md index cf04ad48..490754ab 100644 --- a/EDUGraphAPIs/Rostering/resources/educationuser.md +++ b/EDUGraphAPIs/Rostering/resources/educationuser.md @@ -1,7 +1,7 @@ # educationUser resource type A user in the system. This is an education-specific variant of the user with the same `id` that Microsoft Graph will return from the non-education-specific `/users` endpoint. -This object provides a targeted subset of properties from the core [user](user.md) object and adds a set of education-specific properties such as primaryRole, student, and teacher data. +This object provides a targeted subset of properties from the core [user](user.md) object and adds a set of education-specific properties such as `primaryRole`, student, and teacher data. ## Methods @@ -41,7 +41,7 @@ This object provides a targeted subset of properties from the core [user](user.m |student|[educationStudent](educationstudent.md)| If the primary role is student, this block will contain student specific data.| |surname|String|The user's surname (family name or last name). Supports $filter.| |teacher|[educationTeacher](educationteacher.md)| If the primary role is teacher, this block will conatin teacher specific data.| -|usageLocation|String|A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter.| +|usageLocation|String|A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter.| |userPrincipalName|String|The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md). Supports $filter and $orderby. |userType|String|A string value that can be used to classify user types in your directory, such as “Member†and “Guestâ€. Supports $filter. | diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index ef420ecc..74ca2352 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -10,31 +10,14 @@ The Microsoft Graph API provides access to Office 365 resources through one REST The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The education APIs include two new resources, **rostering** and [educationAssignment](Assignments/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. +The education APIs include two new resources, **rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. ## Authorization -To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). - -### App permissions to enable school IT admins to consent - -To deploy apps that are integrated with the Education APIs in Microsoft Graph, school IT admins must first grant consent to the permissions requested by the app. This consent has to be granted only once, unless the permissions change. After the admin consents, the app is provisioned for all users in the tenant. - -To trigger a consent dialog box, use the following REST call. - -``` -GET https://login.microsoftonline.com/{tenant}/adminconsent? -client_id={clientId}&state=12345&redirect_uri={redirectUrl} -``` - -|Parameter|Description| -|:--------|:----------| -|Tenant|Tenant ID of the school.| -|clientId|Client ID of the app.| -|redirectUrl|App redirect URL.| - +To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. +For more information about permissions for education APIs, see [Permissions](../../../concepts/permissions_reference.md). ## Rostering @@ -47,48 +30,26 @@ You can use the rostering APIs to enable an app user to know: - What I need to do and by when The rostering APIs provide the following key resources: - -- [educationSchool](Rostering/resources/educationschool.md) - Represents the school. -- [educationClass](Rostering/resources/educationclass.md) - Represents a class within a school. -- [educationTerm](Rostering/resources/educationterm.md) - Represents a designated portion of the academic year. -- [educationTeacher](Rostering/resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. -- [educationStudent](Rostering/resources/educationstudent.md) - Represents a users with the primary role of 'student'. +- [educationTeacher](resources/educationteacher.md) - Represents a user with the primary role of 'Teacher'. +- [educationStudent](resources/educationstudent.md) - Represents a user with the primary role of 'student'. The rostering APIs support the following scenarios: - - -- [List all schools](Rostering/api/educationroot_list_schools.md) -- [List schools in which a class is taught](Rostering/api/educationclass_list_schools.md) -- [List schools for a user](Rostering/api/educationuser_list_schools.md) -- [Get all classes](Rostering/api/educationroot_list_classes.md ) -- [Get classes in a school](Rostering/api/educationschool_list_classes.md) -- [List classes for a user](Rostering/api/educationuser_list_classes.md) -- [Add classes to a school](Rostering/api/educationschool_post_classes.md) -- [Get students and teachers for a class](Rostering/api/educationclass_list_members.md) -- [Add members to a class](Rostering/api/educationclass_post_members.md) -- [List teachers for a class](Rostering/api/educationclass_list_teachers.md) -- [Get users in a school](Rostering/api/educationschool_list_users.md) - - +- [Add classes to a school](./api/educationschool_post_classes.md) +- [List classes for a user](./api/educationuser_list_classes.md) +- [List schools for a user](./api/educationuser_list_schools.md) ## Assignments @@ -100,27 +61,27 @@ The Public API is the same API that _Microsoft Teams in Office 365 for Education The assignment APIs provide the following key resources: -- [educationAssignment](Assignments/resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. -- [educationSubmission](Assignments/resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. -- [educationResource](Assignments/resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. +- [educationAssignment](./resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. +- [educationSubmission](.resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. +- [educationResource](resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. The assignment APIs support the following scenarios: -- [Create assignment](Assignments/api/educationclass_post_assignments.md) -- [Publish assignment](Assignments/api/educationassignment_publish.md) -- [Create assignment resource](Assignments/api/educationassignment_post_resources.md) -- [Create submission resource](Assignments/api/educationsubmission_post_resources.md) -- [Submit assignment](Assignments/api/educationsubmission_submit.md) -- [Release grades to student](Assignments/api/educationsubmission_release.md) -- [Get assignment details](Assignments/api/educationuser_list_assignments.md) +- [Create assignment](./api/educationclass_post_assignments.md) +- [Publish assignment](./api/educationassignment_publish.md) +- [Create assignment resource](./api/educationassignment_post_resources.md) +- [Create submission resource](./api/educationsubmission_post_resources.md) +- [Submit assignment](./api/educationsubmission_submit.md) +- [Release grades to student](./api/educationsubmission_release.md) +- [Get assignment details](./api/educationuser_list_assignments.md) The following are some common use cases for the assignment-related education APIs. |Use case|Description|See also| |:-------|:----------|:-------| -|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](Assignments/api/educationassignment_post_resources.md)| -|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](Assignments/api/educationassignment_get.md)| -|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](Assignments/resources/educationsubmission.md)| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| ## Next steps diff --git a/EDUGraphAPIs/permissions_reference.md b/EDUGraphAPIs/permissions_reference.md index 8e6618a3..be480868 100644 --- a/EDUGraphAPIs/permissions_reference.md +++ b/EDUGraphAPIs/permissions_reference.md @@ -255,7 +255,7 @@ For more complex scenarios involving multiple permissions, see [Permission scena --- -## Education permissions +## Education Graph permissions #### Delegated permissions From d3c47d766be6812549fa2599655711a9d223aff7 Mon Sep 17 00:00:00 2001 From: John Austin Date: Wed, 15 Nov 2017 13:31:19 -0800 Subject: [PATCH 61/87] Merge from upstream master --- EDUGraphAPIs/Assignments/GettingStarted.md | 59 ------------ .../api/educationassignment_delete.md | 5 +- .../api/educationassignment_get.md | 4 +- ...ucationassignment_getResourcesFolderUrl.md | 2 +- .../api/educationassignment_list_resources.md | 6 +- .../educationassignment_list_submissions.md | 2 +- .../api/educationassignment_post_resources.md | 2 +- .../api/educationassignment_publish.md | 5 +- .../api/educationassignment_update.md | 2 +- .../api/educationassignmentresource_delete.md | 3 +- .../api/educationassignmentresource_get.md | 2 +- .../api/educationassignmentresource_update.md | 2 +- .../api/educationclass_list_assignments.md | 2 +- .../api/educationclass_post_assignments.md | 2 +- .../api/educationsubmission_get.md | 2 +- .../api/educationsubmission_list_resources.md | 2 +- ...ationsubmission_list_submittedresources.md | 2 +- .../api/educationsubmission_post_resources.md | 2 +- .../api/educationsubmission_recall.md | 2 +- .../api/educationsubmission_release.md | 2 +- .../api/educationsubmission_submit.md | 2 +- .../api/educationsubmission_update.md | 2 +- .../api/educationsubmissionresource_delete.md | 4 +- .../api/educationsubmissionresource_get.md | 2 +- ...ducationsubmittedsubmissionresource_get.md | 2 +- .../api/educationuser_list_assignments.md | 2 +- EDUGraphAPIs/Rostering/GettingStarted.md | 59 ------------ .../Rostering/api/educationclass_delete.md | 15 ++- .../api/educationclass_delete_members.md | 16 +++- .../api/educationclass_delete_teachers.md | 14 ++- .../Rostering/api/educationclass_get.md | 14 ++- .../api/educationclass_list_members.md | 13 ++- .../api/educationclass_list_schools.md | 2 +- .../api/educationclass_list_teachers.md | 13 ++- .../api/educationclass_post_members.md | 18 ++-- .../api/educationclass_post_teachers.md | 21 +++-- .../Rostering/api/educationclass_update.md | 24 +++-- .../api/educationroot_list_classes.md | 9 +- .../api/educationroot_list_schools.md | 11 ++- .../Rostering/api/educationroot_list_users.md | 11 ++- .../api/educationroot_post_classes.md | 17 ++-- .../api/educationroot_post_schools.md | 13 ++- .../Rostering/api/educationroot_post_users.md | 15 ++- .../Rostering/api/educationschool_delete.md | 9 +- .../api/educationschool_delete_classes.md | 13 +-- .../api/educationschool_delete_users.md | 10 +- .../Rostering/api/educationschool_get.md | 9 +- .../api/educationschool_list_classes.md | 11 ++- .../api/educationschool_list_users.md | 11 ++- .../api/educationschool_post_classes.md | 17 ++-- .../api/educationschool_post_users.md | 17 ++-- .../Rostering/api/educationschool_update.md | 13 ++- .../Rostering/api/educationuser_delete.md | 8 +- .../Rostering/api/educationuser_get.md | 11 ++- .../api/educationuser_list_classes.md | 15 ++- .../api/educationuser_list_schools.md | 11 ++- .../Rostering/api/educationuser_update.md | 6 +- .../Rostering/resources/educationuser.md | 2 +- EDUGraphAPIs/education-overview.md | 92 ++++++++++++++----- EDUGraphAPIs/permissions_reference.md | 2 +- 60 files changed, 348 insertions(+), 318 deletions(-) delete mode 100644 EDUGraphAPIs/Assignments/GettingStarted.md delete mode 100644 EDUGraphAPIs/Rostering/GettingStarted.md diff --git a/EDUGraphAPIs/Assignments/GettingStarted.md b/EDUGraphAPIs/Assignments/GettingStarted.md deleted file mode 100644 index 3ac71428..00000000 --- a/EDUGraphAPIs/Assignments/GettingStarted.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft Education Graph Assignments API : Getting Started - - This document provides information for getting started with assignments API. - - ### Understanding Scopes - - The Assignment Service adds a few new scopes to the **Microsoft Graph**. These scopes are used to access Assignment information. The scope applies to all the **Assignment** objects including [Assignment](./resources/educationassignment.md), [Resource](./resources/educationresource.md), and [Submission](./resources/educationsubmission.md). With an App+User Context, the API will only return objects that the user has access to. The "Basic" scopes work the same as the non-basic equivalent scopes, however grade information will not be returned in the Submission objects for "Basic" scopes. - - >**Note:** Students can only access their own Submission. - -#### App-Only Context - -| Role (scope) | Display Name |Description| -|:-----------------|:-------------------|:----------| -|EduAssignments.ReadBasic.All| Read class assignments without grades|Allows the app to read assignments without grades for all users| -|EduAssignments.ReadWriteBasic.All | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| -|EduAssignments.Read.All| Read class assignments with grades | Allows the app to read assignments and their grades for all users | -|EduAssignments.ReadWrite.All | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | - - - -#### App+User Context - -| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | -|:-----------------|:-------------------|:----------|--------------|------------| -|EduAssignments.ReadBasic| Read a user's view of class assignments without grades | Allows the app to read assignments without grades on behalf of the user | View your assignments without grades | Allows the app to view your assignments on your behalf without seeing grades | -|EduAssignments.ReadWriteBasic|Read and write a user's view of class assignments without grades|Allows the app to read and write assignments without grades on behalf of the user|View and modify your assignments without grades|Allows the app to view and modify your assignments on your behalf without seeing grades| -|EduAssignments.Read|Read a user's view of class assignments and their grades|Allows the app to read assignments and their grades on behalf of the user|View your assignments and grades|Allows the app to view your assignments on your behalf including grades| -|EduAssignments.ReadWrite|Read and write a user's view of class assignments and their grades|Allows the app to read and write assignments and their grades on behalf of the user|View and modify your assignments and grades|Allows the app to view and modify your assignments on your behalf including grades| - - - ### Understanding assignment Resources - -Assignment APIs provide the following key resources: - -- [assignment](./resources/educationassignment.md) - **Assignment** is the core object of the Assignments API and owned by the class. -- [Submission](.resources/educationsubmission.md) - **Submission** objects are owned by an assignment. They represents the resources that an individual (or group) submit for an assignment and associated grade/feedback. -- [Resource](resources/educationresource.md) - A resource is associated with an **Assignment** and/or **Submission** and represents the learning object that is being assigned or submitted. - - ### Overview of APIs -Assignments endpoint in EDU Graph provide the following APIs. - -- [Create Assignment](./api/educationclass_post_assignments.md) -- [Publish Assignment](./api/educationassignment_publish.md) -- [Create Assignment Resource](./api/educationassignment_post_resources.md) -- [Create Submission Resource](./api/educationsubmission_post_resources.md) -- [Submit Assignment](./api/educationsubmission_submit.md) -- [Release Grades to student](./api/educationsubmission_release.md) -- [Get assignment Details](./api/educationuser_list_assignments.md) - -Check out the complete set of APIs [here](./api). - - -### Building your first app - -Read the [Microsoft Graph documentation](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using assignment APIs. - - The [EDUGraphAPI - Office 365 Education Code Sample](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) is available from our _GitHub_ repository. Clone the repository to learn about the end to end sample built on Assignments APIs. - diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index 645e807d..a5061104 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -40,13 +40,16 @@ The following is an example of the request. }--> ```http -DELETE https://graph.microsoft.com/beta/education/classes//assignments/ +DELETE https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id} ``` ### Response The following is an example of the response. +<<<<<<< HEAD +======= +>>>>>>> johnau-edits ```http -GET /education/classes//assignments/ +GET /education/classes/{id}/assignments/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -29,7 +29,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationAssignment](../resources/educationassignment.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ##### Request The following is an example of the request. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index 1cd94e7d..c45180d0 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//getResourcesFolderUrl +POST /education/classes/{id}/assignments/{id}/getResourcesFolderUrl ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index fd6651f2..58a180fd 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//resources +GET /education/classes/{id}/assignments/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,7 +27,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationAssignmentResource](../resources/educationassignmentresource.md) objects in the response body. ## Example ##### Request The following is an example of the request. @@ -41,7 +41,7 @@ GET https://graph.microsoft.com/beta/education/classes//assignments//res ##### Response The following is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. ```http -GET /education/classes//assignments//submissions +GET /education/classes/{id}/assignments/{id}/submissions ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md index 3efe1830..aeaa4f93 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//resources +POST /education/classes/{id}/assignments/{id}/resources ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index e1937f85..5509ff50 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//publish +POST /education/classes/{id}/assignments/{id}/publish ``` ## Request headers @@ -23,6 +23,7 @@ POST /education/classes//assignments//publish | Authorization | Bearer {token}. Required. | ## Request body +Do not supply a request body for this method. ## Response If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. @@ -59,4 +60,4 @@ HTTP/1.1 204 No Content "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index 0581d476..9b30b31e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments/ +PATCH /education/classes/{id}/assignments/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md index 47e6c61e..289c4f47 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments//resources/ +DELETE /educationClasses/assignments/{id}/resources/{id} ``` ## Request headers @@ -42,7 +42,6 @@ DELETE https://graph.microsoft.com/beta/education/classes//assignments// ##### Response The following is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All of the properties will be returned from an actual call. ```http -GET /education/classes//assignments//resources/ +GET /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md index 6ef084b0..8f4fb47f 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments//resources/ +PATCH /education/classes/{id}/assignments/{id}/resources/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index 4226d637..37c0fbf2 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments +GET /education/classes/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index 9bf5fca9..a789c7cb 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments +POST /education/classes/{id}/assignments ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md index 6316d80f..7cf1a726 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions/ +GET /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md index 1d0679a2..1d8d1b92 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md @@ -16,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /educationClasses/assignments//submissions//resources +GET /educationClasses/assignments/{id}/submissions/{id}/resources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md index edb83600..0e1b04b2 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions//submittedResources +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md index 36138167..fe564b53 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//resources +POST /education/classes/{id}/assignments/{id}/submissions/{id}/resources ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md index ccefe6d5..b05f5658 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//recall +POST /education/classes//assignments/{id}/submissions/{id}/recall ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md index 1726b47e..f6784d4e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//release +POST /education/classes/{id}/assignments/{id}/submissions/{id}/release ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md index 9189d3a2..93ba33c4 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -POST /education/classes//assignments//submissions//submit +POST /education/classes/{id}/assignments/{id}/submissions/{id}/submit ``` ## Request headers diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md index 38280323..563382e0 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -PATCH /education/classes//assignments//submissions/ +PATCH /education/classes/{id}/assignments/{id}/submissions/{id} ``` ## Request headers | Header | Value | diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md index 2a0dd732..55a2538e 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /educationClasses/assignments//submissions//resources/ +DELETE /educationClasses/assignments/{id}/submissions/{id}/resources/{id} ``` ## Request headers @@ -42,8 +42,6 @@ DELETE https://graph.microsoft.com/beta/education/classes//assignments// ##### Response The following is an example of the response. ->**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. -> ```http -GET /educationn/classes//assignments//submissions//resources/ +GET /educationn/classes/{id}/assignments/{id}/submissions/{id}/resources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md index 20db7b1c..7ff9fd75 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//assignments//submissions//submittedResources/ +GET /education/classes/{id}/assignments/{id}/submissions/{id}/submittedResources/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 90449782..723af8c4 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -15,7 +15,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/assignments/ -GET /education/users//assignments +GET /education/users/{id}/assignments ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/GettingStarted.md b/EDUGraphAPIs/Rostering/GettingStarted.md deleted file mode 100644 index fabf1d44..00000000 --- a/EDUGraphAPIs/Rostering/GettingStarted.md +++ /dev/null @@ -1,59 +0,0 @@ -# Microsoft Education Graph Rostering API : Getting Started - - This document provides information for getting started with Rostering API. - - ### 1. Understanding Scopes - - The Rostering Service adds a few new Scopes to the Microsoft Graph. These Scopes need to be used to access Roster information. Scopes are the way users or administrators decide what information an application (or more practically the vendor who creates an application) has access to. In app+user scenarios, the intersection of the user’s permissions and the application’s scopes define the data that the running app can work with. - -#### App-Only Context - -| Role | Display Name |Description| -|:-----------------|:-------------------|:----------| -|EduRostering.ReadBasic.All| Read a limited subset of the organization's roster. |Allows the app to read a limited subset of both the structure of schools and classes in an organization's roster and education-specific information about all users.| -|EduRostering.Read.All | Read the organization's roster. | Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read. | -|EduRostering.ReadWrite.All| Read and write the organization's roster. | Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written. | - - -#### App+User Context - -| Scope | Admin Display Name | Admin Description | User Consent Display name | User Consent Description | -|:-----------------|:-------------------|:----------|--------------|------------| -EduRostering.ReadBasic| Read a limited subset of a user's view of the roster | Allows the app to read a limited subset of the data from the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user. |View a limited subset of your school, class and user information. |Allows the app to view a limited subset of the information about schools and classes in your organization and education-related information about you and other users on your behalf. | - - - ### 2. Understanding Education Roster Resources - -assignment APIs provide the following key resources: - -- [School](resources/educationschool.md) - A resource that represents the school. -- [Class](./resources/educationclass.md) - Represents a class within a school. -- [Term](resources/educationterm.md) - Represents a designated portion of the academic year. -- [Teacher ](resources/educationteacher.md) - Represents a users with primary Role 'Teacher'. -- [Student](resources/educationstudent.md) - Represents a users with primary Role 'student'. - - ### 3. Overview of APIs -assignments endpoint in EDU Graph provide the following APIs. - -- [Get Students and Teachers for a Class](./api/educationclass_list_members.md) -- [List Schools I teach](./api/educationclass_list_schools.md) -- [List Teachers for a class](./api/educationclass_list_teachers.md) -- [Add Members to a Class](./api/educationclass_post_members.md) -- [Get All Classes](./api/educationroot_list_classes.md ) -- [List All Schools](./api/educationroot_list_schools.md) -- [Get Classes in a School](./api/educationschool_list_classes.md) -- [Get users in a school](./api/educationschool_list_users.md) -- [Add Classes to a School](./api/educationschool_post_classes.md) -- [List of Classes for a user](./api/educationuser_list_classes.md) -- [List of Schools for a user](./api/educationuser_list_schools.md) - - -Check out the complete set of APIs [here](./api). - - -### 4. Building your first app - -Follow the Microsoft Graph documentation [here](https://developer.microsoft.com/en-us/graph/docs/concepts/get-started) for building your first app using Rostering APIs. - -Getting Started Sample : Browse [here](https://github.com/OfficeDev/O365-EDU-AspNetMVC-Samples) to checkout the end to end sample built on Rostering APIs. - diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete.md b/EDUGraphAPIs/Rostering/api/educationclass_delete.md index bd33a0de..2527ab4e 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete.md @@ -1,6 +1,10 @@ # Delete educationClass +<<<<<<< HEAD +Delete a class. Because a class is also a universal group, deleting a class deletes the group. +======= Delete a class. A class is also a universal group so the group is deleted as well. +>>>>>>> johnau-edits ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +18,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/classes/ +DELETE /education/classes/{id} ``` ## Request headers @@ -27,11 +31,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE /education/classes//members/{userId}/$ref +DELETE /education/classes/{id}/members/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,11 +32,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and empty response body. +If successful, this method returns a `204 No Content` response code and an empty response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE /education/classes//teachers/{userId}/$ref +DELETE /education/classes/{id}/teachers/{userId}/$ref ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and empty response body. +If successful, this method returns a `204 No Content` response code and an empty response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET /education/classes/ +GET /education/classes/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,7 +31,7 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request Here is an example of the request. @@ -39,9 +43,15 @@ Here is an example of the request. GET https://graph.microsoft.com/beta/education/classes/11023 ``` ##### Response +<<<<<<< HEAD +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. +======= Here is an example of the response. >Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +>>>>>>> johnau-edits ```http -GET /education/classes//members +GET /education/classes/{id}/members ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET /education/classes//schools +GET /education/classes/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 1d012d2e..55d1e588 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -1,6 +1,6 @@ # List teachers -Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. +Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +14,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -GET /education/classes//teachers +GET /education/classes/{id}/teachers ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST /education/classes//members/$ref +POST /education/classes/{id}/members/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/classes//members/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST /education/classes//teachers/$ref +POST /education/classes/{id}/teachers/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/classes//teachers/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + +>**Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call. + ```http -PATCH /education/classes/ +PATCH /education/classes/{id} ``` ## Request headers | Header | Value | @@ -23,23 +23,24 @@ PATCH /education/classes/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| -|description|String| Description of the class| -|displayName|String| Name of the Class| -|mailNickname|String| Mail name for sending email to all users if this is enabled. | -|classCode|String| Class Code used by the school.| +|description|String| Description of the class.| +|displayName|String| Name of the class.| +|mailNickname|String| Email alias for sending email to all users if that feature is enabled. | + +|classCode|String| Class code used by the school.| |externalId|String| ID of the class from the syncing system. | |externalName|String|Name of the class in the syncing system.| -|externalSource|string| How this class was creaeted. Possible values are: `sis`, `manual`, `enum_sentinel`.| +|externalSource|string| How this class was created. Possible values are: `sis`, `manual`, `enum_sentinel`.| ## Response -If successful, this method returns a `200 OK` response code and updated [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -23,15 +25,15 @@ POST /education/users | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `201, Created` response code and [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE /education/schools/ +DELETE /education/schools/{id} ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE /education/schools//classes/{classId}/$ref +DELETE /education/schools/{id}/classes/{classId}/$ref ``` ## Request headers | Header | Value | @@ -26,11 +26,11 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code and a response body. +If successful, this method returns a `204 No Content` response code and a response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -DELETE https://graph.microsoft.com/beta/education/schools//users/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/{id}/users/{userId}/$ref ``` -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. + ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. ```http -GET /education/schools//classes +GET /education/schools/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -GET /education/schools//users +GET /education/schools/{id}/users ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationUser](../resources/educationuser.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http -POST /education/schools//classes/$ref +POST /education/schools/{id}/classes/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/schools//classes/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationClass](../resources/educationclass.md) object. +In the request body, supply a JSON representation of an [educationClass](../resources/educationclass.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ```http -POST /education/schools//users/$ref +POST /education/schools/{id}/users/$ref ``` ## Request headers | Header | Value | @@ -23,15 +23,15 @@ POST /education/schools//users/$ref | Content-Type | application/json | ## Request body -In the request body, supply a JSON representation of [educationUser](../resources/educationuser.md) object. +In the request body, supply a JSON representation of an [educationUser](../resources/educationuser.md) object. ## Response -If successful, this method returns `204, No Content` response code and [educationClass](../resources/educationclass.md) object in the response body. +If successful, this method returns a `204 No Content` response code and an [educationClass](../resources/educationclass.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ```http -PATCH /education/schools/ +PATCH /education/schools/{id} ``` ## Request headers | Header | Value | @@ -23,7 +23,7 @@ PATCH /education/schools/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| @@ -42,10 +42,10 @@ In the request body, supply the values for relevant fields that should be update |createdBy|[identitySet](identityset.md)|Entity who created the school.| ## Response -If successful, this method returns a `200 OK` response code and updated [educationSchool](../resources/educationschool.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [educationSchool](../resources/educationschool.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -14,7 +16,7 @@ One of the following permissions is required to call this API. To learn more, in ## HTTP request ```http -DELETE /education/users/ +DELETE /education/users/{id} ``` ## Request headers | Header | Value | @@ -26,7 +28,7 @@ Do not supply a request body for this method. ## Response -If successful, this method returns `204, No Content` response code. It does not return anything in the response body. +If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. ## Example ##### Request @@ -39,7 +41,7 @@ Here is an example of the request. DELETE https://graph.microsoft.com/beta/education/users/ ``` ##### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +The following is an example of the response. ```http GET /education/me -GET /education/users/ +GET /education/users/{id} ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and [educationUser](../resources/educationuser.md) object in the response body. +If successful, this method returns a `200 OK` response code and an [educationUser](../resources/educationuser.md) object in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -15,7 +17,7 @@ One of the following permissions is required to call this API. To learn more, in ```http GET /education/me/classes -GET /education/users//classes +GET /education/users/{id}/classes ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -28,10 +30,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationClass](../resources/educationclass.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationClass](../resources/educationclass.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http GET /education/me/schools -GET /education/users//schools +GET /education/users/{id}/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. @@ -27,10 +27,10 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs ## Request body Do not supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and collection of [educationSchool](../resources/educationschool.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [educationSchool](../resources/educationschool.md) objects in the response body. ## Example ##### Request -Here is an example of the request. +The following is an example of the request. ```http PATCH /education/me -PATCH /education/users/ +PATCH /education/users/{id} ``` ## Request headers | Header | Value | @@ -23,7 +23,7 @@ PATCH /education/users/ | Content-Type | application/json | ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. | Property | Type |Description| |:---------------|:--------|:----------| diff --git a/EDUGraphAPIs/Rostering/resources/educationuser.md b/EDUGraphAPIs/Rostering/resources/educationuser.md index 490754ab..5fbea54c 100644 --- a/EDUGraphAPIs/Rostering/resources/educationuser.md +++ b/EDUGraphAPIs/Rostering/resources/educationuser.md @@ -41,7 +41,7 @@ This object provides a targeted subset of properties from the core [user](user.m |student|[educationStudent](educationstudent.md)| If the primary role is student, this block will contain student specific data.| |surname|String|The user's surname (family name or last name). Supports $filter.| |teacher|[educationTeacher](educationteacher.md)| If the primary role is teacher, this block will conatin teacher specific data.| -|usageLocation|String|A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter.| +|usageLocation|String|A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: "US", "JP", and "GB". Not nullable. Supports $filter.| |userPrincipalName|String|The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the **verifiedDomains** property of [organization](organization.md). Supports $filter and $orderby. |userType|String|A string value that can be used to classify user types in your directory, such as “Member†and “Guestâ€. Supports $filter. | diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index 74ca2352..56ce1664 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -10,14 +10,31 @@ The Microsoft Graph API provides access to Office 365 resources through one REST The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The education APIs include two new resources, **rostering** and [educationAssignment](resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. +The education APIs include two new resources, **rostering** and [educationAssignment](Assignments/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. ## Authorization -To call the education APIs in Microsoft Graph, your app will need the appropriate permissions. -For more information about permissions for education APIs, see [Permissions](../../../concepts/permissions_reference.md). +To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_overview). Your app will also need the appropriate permissions. For more information, see [Education permissions](EDUGraphAPIs/permissions_reference.md#education-permissions). + +### App permissions to enable school IT admins to consent + +To deploy apps that are integrated with the Education APIs in Microsoft Graph, school IT admins must first grant consent to the permissions requested by the app. This consent has to be granted only once, unless the permissions change. After the admin consents, the app is provisioned for all users in the tenant. + +To trigger a consent dialog box, use the following REST call. + +``` +GET https://login.microsoftonline.com/{tenant}/adminconsent? +client_id={clientId}&state=12345&redirect_uri={redirectUrl} +``` + +|Parameter|Description| +|:--------|:----------| +|Tenant|Tenant ID of the school.| +|clientId|Client ID of the app.| +|redirectUrl|App redirect URL.| + ## Rostering @@ -30,26 +47,53 @@ You can use the rostering APIs to enable an app user to know: - What I need to do and by when The rostering APIs provide the following key resources: - + +- [educationSchool](Rostering/resources/educationschool.md) - Represents the school. +- [educationClass](Rostering/resources/educationclass.md) - Represents a class within a school. +- [educationTerm](Rostering/resources/educationterm.md) - Represents a designated portion of the academic year. +- [educationTeacher](Rostering/resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. +- [educationStudent](Rostering/resources/educationstudent.md) - Represents a users with the primary role of 'student'. +======= - [educationTeacher](resources/educationteacher.md) - Represents a user with the primary role of 'Teacher'. - [educationStudent](resources/educationstudent.md) - Represents a user with the primary role of 'student'. +>>>>>>> johnau-edits The rostering APIs support the following scenarios: -- [Get students and teachers for a class](./api/educationclass_list_members.md) + + +- [List all schools](Rostering/api/educationroot_list_schools.md) +- [List schools in which a class is taught](Rostering/api/educationclass_list_schools.md) +- [List schools for a user](Rostering/api/educationuser_list_schools.md) +- [Get all classes](Rostering/api/educationroot_list_classes.md ) +- [Get classes in a school](Rostering/api/educationschool_list_classes.md) +- [List classes for a user](Rostering/api/educationuser_list_classes.md) +- [Add classes to a school](Rostering/api/educationschool_post_classes.md) +- [Get students and teachers for a class](Rostering/api/educationclass_list_members.md) +- [Add members to a class](Rostering/api/educationclass_post_members.md) +- [List teachers for a class](Rostering/api/educationclass_list_teachers.md) +- [Get users in a school](Rostering/api/educationschool_list_users.md) + + ## Assignments @@ -61,27 +105,27 @@ The Public API is the same API that _Microsoft Teams in Office 365 for Education The assignment APIs provide the following key resources: -- [educationAssignment](./resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. -- [educationSubmission](.resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. -- [educationResource](resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. +- [educationAssignment](Assignments/resources/educationassignment.md) - The core object of the assignments API. Represents a task or unit of work assigned to a student or team member in a class as part of their study. +- [educationSubmission](Assignments/resources/educationsubmission.md) - Represents the resources that an individual (or group) submits for an assignment and the associated grade and feedback for that assignment. +- [educationResource](Assignments/resources/educationresource.md) - Represents the learning object that is being assigned or submitted. An **educationResource** is associated with an **educationAssignment** and/or an **educationSubmission**. The assignment APIs support the following scenarios: -- [Create assignment](./api/educationclass_post_assignments.md) -- [Publish assignment](./api/educationassignment_publish.md) -- [Create assignment resource](./api/educationassignment_post_resources.md) -- [Create submission resource](./api/educationsubmission_post_resources.md) -- [Submit assignment](./api/educationsubmission_submit.md) -- [Release grades to student](./api/educationsubmission_release.md) -- [Get assignment details](./api/educationuser_list_assignments.md) +- [Create assignment](Assignments/api/educationclass_post_assignments.md) +- [Publish assignment](Assignments/api/educationassignment_publish.md) +- [Create assignment resource](Assignments/api/educationassignment_post_resources.md) +- [Create submission resource](Assignments/api/educationsubmission_post_resources.md) +- [Submit assignment](Assignments/api/educationsubmission_submit.md) +- [Release grades to student](Assignments/api/educationsubmission_release.md) +- [Get assignment details](Assignments/api/educationuser_list_assignments.md) The following are some common use cases for the assignment-related education APIs. |Use case|Description|See also| |:-------|:----------|:-------| -|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](../api/educationassignment_post_resources.md)| -|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](../api/educationassignment_get.md)| -|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](educationsubmission.md)| +|Create assignments|An external system can create an assignment for the class and attach resources to the assignment.|[Create assignment](Assignments/api/educationassignment_post_resources.md)| +|Read assignment information|An analytics application can get information about assignments and student submissions, including dates and grades.|[Get assignment](Assignments/api/educationassignment_get.md)| +|Track student submissions|Your app can provide a teacher dashboard that shows how many submissions from students need to be graded.|[Submission resource](Assignments/resources/educationsubmission.md)| ## Next steps diff --git a/EDUGraphAPIs/permissions_reference.md b/EDUGraphAPIs/permissions_reference.md index be480868..8e6618a3 100644 --- a/EDUGraphAPIs/permissions_reference.md +++ b/EDUGraphAPIs/permissions_reference.md @@ -255,7 +255,7 @@ For more complex scenarios involving multiple permissions, see [Permission scena --- -## Education Graph permissions +## Education permissions #### Delegated permissions From ad687ec8593539dbd73e64806dcb66f32e0b9260 Mon Sep 17 00:00:00 2001 From: John Austin Date: Wed, 15 Nov 2017 13:34:09 -0800 Subject: [PATCH 62/87] remove merge tokens --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 563db67e..5afa531a 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,12 +1,6 @@ -<<<<<<< HEAD -# Delete educationUser (member) - -Delete a member from a class. -======= # Delete a student from an educationClass Delete a student from a class. ->>>>>>> johnau-edits ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 862dbbcf90c86957e6862b9412a759fd0af40792 Mon Sep 17 00:00:00 2001 From: John Austin Date: Wed, 15 Nov 2017 13:34:57 -0800 Subject: [PATCH 63/87] completed manual merge --- .../Assignments/api/educationassignment_delete.md | 4 ---- EDUGraphAPIs/Rostering/api/educationclass_delete.md | 8 -------- .../Rostering/api/educationclass_delete_members.md | 5 ----- .../Rostering/api/educationclass_delete_teachers.md | 4 ---- EDUGraphAPIs/Rostering/api/educationclass_get.md | 10 ---------- EDUGraphAPIs/education-overview.md | 5 ----- 6 files changed, 36 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index a5061104..63a560d3 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -45,11 +45,7 @@ DELETE https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id} ### Response The following is an example of the response. -<<<<<<< HEAD -======= - ->>>>>>> johnau-edits @@ -60,10 +59,6 @@ The rostering APIs provide the following key resources: - [educationTerm](Rostering/resources/educationterm.md) - Represents a designated portion of the academic year. - [educationTeacher](Rostering/resources/educationteacher.md) - Represents a users with the primary role of 'Teacher'. - [educationStudent](Rostering/resources/educationstudent.md) - Represents a users with the primary role of 'student'. -======= -- [educationTeacher](resources/educationteacher.md) - Represents a user with the primary role of 'Teacher'. -- [educationStudent](resources/educationstudent.md) - Represents a user with the primary role of 'student'. ->>>>>>> johnau-edits The rostering APIs support the following scenarios: From 1825b95c35ffda2d3c6cf45f3e11b1cf08ce381f Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 15 Nov 2017 19:19:00 -0800 Subject: [PATCH 64/87] Update title. --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 724d29aa..2516cce0 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,4 +1,4 @@ -# Delete educationUser (member) +# Delete educationUser (student) Delete a member from a class. @@ -58,4 +58,4 @@ HTTP/1.1 204 No Content "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 1e9dfdb290de9f378cfdef3863672c7de79564b4 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 15 Nov 2017 19:19:37 -0800 Subject: [PATCH 65/87] Another fix. --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 2516cce0..deab8f7c 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,6 +1,6 @@ # Delete educationUser (student) -Delete a member from a class. +Delete a student from a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 148a777afef44aa2a5344390a0d384dc7066e49e Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 09:34:35 -0800 Subject: [PATCH 66/87] Edit. --- EDUGraphAPIs/Assignments/api/educationassignment_publish.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index 5509ff50..3b19a167 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -1,6 +1,6 @@ # educationAssignment: publish -This action changes the state of an assignment from its original draft status to the published status. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment, nor will there be any submission objects. When you call this API submission object is created and the assignment appears in the student's list. +This action changes the state of an assignment from its original draft status to the published status. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment, nor will there be any submission objects. When you call this API, submission objects are created and the assignment appears in the student's list. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 285b9933f74fd8d5ab27179adb1fa829bf9ebbd9 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 09:36:17 -0800 Subject: [PATCH 67/87] Edit. --- EDUGraphAPIs/Assignments/api/educationsubmission_update.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md index 563382e0..1a15fe20 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md @@ -1,6 +1,6 @@ # Update educationsubmission -Add a grade and feedback to a submission. Only teachers can perform this operation. Note that the Basic permission is not allowed because it does not provide access to the grade properties. This action does not release the grade and feedback to the student. A teacher must take an explicit release action for the grade data to be returned to the student. +Add a grade and feedback to a submission. Only teachers can perform this operation. Note that the Basic permission does not have access to the grade properties, and therefore cannot write to grade or feedback. This action does not release the grade and feedback to the student. A teacher must take an explicit release action for the grade data to be returned to the student. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -87,4 +87,4 @@ Content-length: 712 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From f0f38cdbe8278c64a2cff29ea17b540780a4d8c6 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 09:37:50 -0800 Subject: [PATCH 68/87] Edit. --- .../api/educationsubmittedsubmissionresource_get.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md index 7ff9fd75..894bfa44 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md @@ -1,6 +1,6 @@ # Get educationSubmittedSubmissionResource -Returns the submitted resource. This will be available to a teacher after a student has submitted, and will be available to the student after the teacher has released the submission. Note that teachers can leave notes in some resources. +Returns a submitted resource. This will be available to a teacher after a student has submitted, and will be available to the student after the teacher has released the submission. Note that teachers can leave notes in some resources. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -68,4 +68,4 @@ Content-length: 868 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 11bdbc77484083023d205eb5c2d7450724054471 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 10:24:56 -0800 Subject: [PATCH 69/87] Changed member to student. --- EDUGraphAPIs/Rostering/resources/educationclass.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Rostering/resources/educationclass.md b/EDUGraphAPIs/Rostering/resources/educationclass.md index 3e0c0067..834a2e90 100644 --- a/EDUGraphAPIs/Rostering/resources/educationclass.md +++ b/EDUGraphAPIs/Rostering/resources/educationclass.md @@ -10,7 +10,7 @@ Represents a class within a school. The **educationClass** resource corresponds |[Get educationClass](../api/educationclass_get.md) | [educationClass](educationclass.md) |Read properties and relationships of an **educationClass** object.| |[Add member](../api/educationclass_post_members.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the members navigation property.| |[List members](../api/educationclass_list_members.md) |[educationUser](educationuser.md) collection| Get an **educationUser** object collection.| -|[Remove member](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the members navigation property.| +|[Remove student](../api/educationclass_delete_members.md) |[educationUser](educationuser.md)| Remove an **educationUser** from the class through the members navigation property.| |[List schools](../api/educationclass_list_schools.md) |[educationSchool](educationschool.md) collection| Get an **educationSchool** object collection.| |[Add teacher](../api/educationclass_post_teachers.md) |[educationUser](educationuser.md)| Add a new **educationUser** for the class by posting to the teachers navigation property.| |[List teachers](../api/educationclass_list_teachers.md) |[educationUser](educationuser.md) collection| Get a list of teachers for the class.| @@ -79,4 +79,4 @@ The following is a JSON representation of the resource. "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 4af0d70c4390726616f85a750e55ba38fcde773f Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 12:58:14 -0800 Subject: [PATCH 70/87] Deleted the Important. --- .../Assignments/resources/educationonenoteresource.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md index 586d10d0..0871993e 100644 --- a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md @@ -2,12 +2,6 @@ A subclass of [educationResource](educationresource.md). This represents the location of the OneNote page. - - ->**Important:** This API currently uses a different syntax. This will be -replaced by the representation (single property). - ## Properties | Property | Type |Description| |:---------------|:--------|:----------| From a139495d65cd144d49a3a94e3846325852aa0dbb Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 12:59:14 -0800 Subject: [PATCH 71/87] Edit. --- .../Assignments/resources/educationassignmentresource.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md index 89d59714..27ec53ef 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md @@ -2,7 +2,7 @@ A wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will be copied to the student submission. If the object is not copied, each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student -will receive a copy of this resource in the resource list of their assignment. Each student will be able to modify their copy and submit it for grading. +will receive a copy of this resource in the resource list of their submission. Each student will be able to modify their copy and submit it for grading. ## Methods From 9cd4513807a4bd4aebe943a60298517bb05acae8 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 13:34:29 -0800 Subject: [PATCH 72/87] Edit. --- EDUGraphAPIs/Rostering/resources/educationschool.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/EDUGraphAPIs/Rostering/resources/educationschool.md b/EDUGraphAPIs/Rostering/resources/educationschool.md index 3d13b6c0..6df5a608 100644 --- a/EDUGraphAPIs/Rostering/resources/educationschool.md +++ b/EDUGraphAPIs/Rostering/resources/educationschool.md @@ -25,7 +25,7 @@ This resource is a subtype of [educationOrganization](educationorganization.md). |id|String|GUID of this school.| |displayName| String| Display name of the school.| |description| String | Description of the school.| -|status| string| Read-Only. Possible values are: `inactive`, `active`, `expired`, `deleteable`.| +|status| string| Read-Only. Possible values are: `inactive`, `active`, `expired`, `deleteable`.| |externalSource| string| Read-Only. Possible values are: `sis`, `manual`, `unknownFutureValue`.| |principalEmail| String| Email address of the principal.| |principalName| String | Name of the principal.| @@ -36,7 +36,7 @@ This resource is a subtype of [educationOrganization](educationorganization.md). |externalId|String| ID of school in syncing system. | |phone|String| Phone number of school. | |fax|String| Fax number of school. | -|address|[physicalAddress](physicaladdress.md)| Address of the School.| +|address|[physicalAddress](physicaladdress.md)| Address of the school.| |createdBy|[identitySet](identityset.md)|Entity who created the school.| @@ -87,4 +87,4 @@ The following is a JSON representation of the resource. "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 78efdafe4d66555298be4c92a91fc975ee2b00aa Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 13:38:30 -0800 Subject: [PATCH 73/87] Edits. --- EDUGraphAPIs/education-overview.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index ef420ecc..f090c52a 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -1,18 +1,8 @@ # Working with education APIs in Microsoft Graph - - The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. -The education APIs include two new resources, **rostering** and [educationAssignment](Assignments/resources/educationassignment.md), that you can use to interact with the assignment and rostering services in Microsoft Teams. You can use these resources to automate student assignments and manage a school roster. - - +The education APIs include rostering resources and assignments resources that you can use to interact with the rostering and assignment services in Microsoft Teams. You can use these resources to manage a school roster and automate student assignments. ## Authorization @@ -31,14 +21,14 @@ client_id={clientId}&state=12345&redirect_uri={redirectUrl} |Parameter|Description| |:--------|:----------| -|Tenant|Tenant ID of the school.| +|Tenant|Tenant ID of the school. Use the full ID, which includes onmicrosoft.com.| |clientId|Client ID of the app.| |redirectUrl|App redirect URL.| ## Rostering -The rostering APIs enable you to extract data from a school's Office 365 tenant provisioned with Microsoft School Data Sync. These APIs provide access to information about schools, sections, teachers, students, and rosters. The APIs support both app-only (sync) scenarios, and app + user (interactive) scenarios. The APIs that support interactive scenarios enforce region-appropriate RBAC policies based on the user role calling the API. This provides a consistent API and minimal policy surface, regardless of the administrative configuration within tenants. In addition, the APIs also provide education-specific permissions to ensure that the right user has access to the data. +The rostering APIs enable you to extract data from a school's Office 365 tenant provisioned with [Microsoft School Data Sync](https://sds.microsoft.com/). These APIs provide access to information about schools, sections, teachers, students, and rosters. The APIs support both app-only (sync) scenarios, and app + user (interactive) scenarios. The APIs that support interactive scenarios enforce region-appropriate RBAC policies based on the user role calling the API. This provides a consistent API and minimal policy surface, regardless of the administrative configuration within tenants. In addition, the APIs also provide education-specific permissions to ensure that the right user has access to the data. You can use the rostering APIs to enable an app user to know: From b7d6e9240ed9d824ae201b063dd99c5cb38181d5 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 13:39:10 -0800 Subject: [PATCH 74/87] Delete comment. --- EDUGraphAPIs/Rostering/api/educationclass_list_schools.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 62b7ff5e..6d751e38 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -2,8 +2,6 @@ Retrieve a list of schools in which the class is taught. - - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -89,4 +87,4 @@ Content-length: 345 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 325ed9d41f02acfcd3fe5e0b929c88a951c9ab3a Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 13:58:39 -0800 Subject: [PATCH 75/87] Changed Delete to Remove. --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index deab8f7c..5461d3c3 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,6 +1,6 @@ -# Delete educationUser (student) +# Remove educationUser (student) -Delete a student from a class. +Remove a student from a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 81e9231a6f78f7c73ba9d32c0ebc010f98a7d66c Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 13:59:06 -0800 Subject: [PATCH 76/87] Changed Delete to Remove. --- .../Rostering/api/educationclass_delete_teachers.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index c709228f..53627d2c 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,6 +1,6 @@ -# Delete educationUser (teacher) +# Remove educationUser (teacher) -Delete a teacher from a class. +Remove a teacher from a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -58,4 +58,4 @@ HTTP/1.1 204 No Content "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}--> From 121ca8792ac7ab9dd2716b939b1bfc3dfcc0b4f2 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Thu, 16 Nov 2017 14:34:01 -0800 Subject: [PATCH 77/87] Edit. --- EDUGraphAPIs/Rostering/resources/educationclass.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Rostering/resources/educationclass.md b/EDUGraphAPIs/Rostering/resources/educationclass.md index 834a2e90..58dea31c 100644 --- a/EDUGraphAPIs/Rostering/resources/educationclass.md +++ b/EDUGraphAPIs/Rostering/resources/educationclass.md @@ -1,6 +1,6 @@ # educationClass resource type -Represents a class within a school. The **educationClass** resource corresponds to the Office Group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections. +Represents a class within a school. The **educationClass** resource corresponds to the Office 365 group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections. ## Methods From 66b10f3c248b7f26a8f0636cc6da8d440e3ce641 Mon Sep 17 00:00:00 2001 From: John Austin Date: Thu, 16 Nov 2017 16:54:21 -0800 Subject: [PATCH 78/87] added json exaamples with 'real' values --- .vscode/settings.json | 3 + .../api/educationclass_delete_members.md | 6 +- .../api/educationclass_delete_teachers.md | 6 +- .../Rostering/api/educationclass_get.md | 2 +- .../api/educationclass_list_members.md | 87 ++++++++++++++++--- .../api/educationclass_list_schools.md | 45 ++++++---- .../api/educationclass_list_teachers.md | 45 +++++++--- .../api/educationclass_post_members.md | 8 +- .../api/educationclass_post_teachers.md | 6 +- .../Rostering/api/educationclass_update.md | 31 ++++--- .../api/educationroot_list_classes.md | 23 +++-- .../api/educationroot_list_schools.md | 43 +++++---- .../Rostering/api/educationroot_list_users.md | 41 ++++++--- .../api/educationroot_post_classes.md | 49 +++++++---- .../api/educationschool_delete_users.md | 2 +- .../api/educationschool_post_classes.md | 2 +- .../api/educationschool_post_users.md | 2 +- .../Rostering/api/educationschool_update.md | 2 +- .../Rostering/api/educationuser_update.md | 2 +- 19 files changed, 272 insertions(+), 133 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..d7ab3f99 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "workbench.colorTheme": "Default Light+" +} \ No newline at end of file diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index e1be48b6..004e8f0d 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,6 +1,6 @@ -# Delete a student from an educationClass +# Remove a student from a class roster -Delete a student from a class. +Removes a student from a class roster. an [educationUser](../resources/educationuser.md) with a **primaryRole** of `student` from an [educationClass](../resources/educationclass.md) ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008/$ref +DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008 ``` ##### Response diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index c709228f..d7426663 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,6 +1,6 @@ -# Delete educationUser (teacher) +# Remove a teacher -Delete a teacher from a class. +Remove an [educationUser](../resources/educationuser.md) with a **primaryRole** of "teacher" from an [educationClass](../resources/educationclass.md) ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -DELETE https://graph.microsoft.com/beta/education/classes//teachers/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/classes//teachers/14012 ``` ##### Response diff --git a/EDUGraphAPIs/Rostering/api/educationclass_get.md b/EDUGraphAPIs/Rostering/api/educationclass_get.md index 53b3d7f3..cb856c52 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_get.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_get.md @@ -1,6 +1,6 @@ # Get educationClass -Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members. +Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are a student or teacher. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md index 7461e9f2..ddb37980 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md @@ -1,6 +1,8 @@ # List members -Retrieves the teachers and students for a class. Note that if the delegated token is used, members can only be seen by other members of the class. +Retrieves the teacher and students for a class. + +>**Note:** If the delegated token is used, only a class member can retrieve other members of the class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +38,7 @@ The following is an example of the request. "name": "get_members" }--> ```http -GET https://graph.microsoft.com/beta/education/classes//members +GET https://graph.microsoft.com/beta/education/classes/11016/members ``` ##### Response The following is an example of the response. @@ -57,18 +59,75 @@ Content-length: 593 { "value": [ { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "13013", + "displayName": "Ora Klein", + "givenName": "Ora", + "middleName": " ", + "surname": "Klein", + "mail": "OraK@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "externalSource": "School of Fine Art", + "mailingAddress": { + "city": "Buffalo", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "NY", + "street": "12345 Main St." + }, + "primaryRole": "teacher", + "externalId": "13013", + "teacherNumber": "8802", + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + }, + { + "id": "13005", + "displayName": "Erna Parker", + "givenName": "Erna", + "middleName": " ", + "surname": "Parker", + "mail": "ernap@contoso.com", + "mobilePhone": "+1 (253) 555-0104", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "externalSource": "School of Fine Art", + "mailingAddress": { + "city": "Buffalo", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "NY", + "street": "12345 Main St." + }, + "primaryRole": "student", + "externalId": "13005", + "birthDate": "2001-01-01T00:00:00Z", + "externalId": "123", + "gender": "female", + "grade": "9", + "graduationYear": "2019", + "studentNumber": "13005", + "residenceAddress": { + "city": "Long Beach", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Maple St." + }, } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 62b7ff5e..7ee918c8 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -1,6 +1,6 @@ # List schools -Retrieve a list of schools in which the class is taught. +Retrieve a list of schools where a class is taught. @@ -39,7 +39,7 @@ The following is an example of the request. "name": "get_schools" }--> ```http -GET https://graph.microsoft.com/beta/education/classes//schools +GET https://graph.microsoft.com/beta/education/classes/11014/schools ``` ##### Response The following is an example of the response. @@ -55,27 +55,38 @@ The following is an example of the response. ```http HTTP/1.1 200 OK Content-type: application/json -Content-length: 345 +Content-length: 892 { "value": [ { - "id": "String", - "displayName": "String", - "description": "String", + "id": "10002", + "displayName": "Fabrikam High School", + "description": "Magnate school for the arts. Los Angeles School District", "status": "String", "externalSource": "String", - "principalEmail": "String", - "principalName": "String", - "externalPrincipalId": "String", - "highestGrade": "String", - "lowestGrade": "String", - "schoolNumber": "String", - "address": {"@odata.type": "microsoft.graph.physicalAddress"}, - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalId": "String", - "fax": "String", - "phone": "String", + "principalEmail": "AmyR@fabrikam.com", + "principalName": "Amy Roebuck", + "externalPrincipalId": "14007", + "highestGrade": "12", + "lowestGrade": "9", + "schoolNumber": "10002", + "address": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "externalId": "10002", + "fax": "+1 (253) 555-0101", + "phone": "+1 (253) 555-0102", } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 55d1e588..1952099f 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -1,6 +1,6 @@ # List teachers -Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. +Retrieve a list of teachers for a class. Only delegated tokens for a member of a class can get teachers for that class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "get_teachers" }--> ```http -GET https://graph.microsoft.com/beta/education/classes//teachers +GET https://graph.microsoft.com/beta/education/classes/11023/teachers ``` ##### Response The following is an example of the response. @@ -57,18 +57,35 @@ Content-length: 593 { "value": [ { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "14006", + "displayName": "Kristie Mitchell", + "givenName": "Kristie", + "middleName": "Anne", + "surname": "Mitchell", + "mail": "kristiem@Contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "externalSource": "Edu", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "primaryRole": "Teacher", + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md index 1ba3240a..94de9e80 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md @@ -1,6 +1,6 @@ -# Create educationUser (member) +# Add a student to a class roster -Add a member to a class. +Add a student to a class. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -37,12 +37,12 @@ The following is an example of the request. "name": "create_educationuser_from_educationclass" }--> ```http -POST https://graph.microsoft.com/beta/education/classes//members/$ref +POST https://graph.microsoft.com/beta/education/classes/11011/members/$ref Content-type: application/json Content-length: 56 { - "@odata.id":"https://graph.microsoft.com/beta/education/users/{userId}"� + "@odata.id":"https://graph.microsoft.com/beta/education/users/13015"� } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md index d9fe81b0..72f674c4 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md @@ -1,4 +1,4 @@ -# Create educationUser (teacher) +# Add an educationUser (teacher) to an educationClass Add a teacher to a class. @@ -37,12 +37,12 @@ The following is an example of the request. "name": "create_educationuser_from_educationclass" }--> ```http -POST https://graph.microsoft.com/beta/education/classes//teachers/$ref +POST https://graph.microsoft.com/beta/education/classes/11017/teachers/$ref Content-type: application/json Content-length: 508 { - "@odata.id":"https://graph.microsoft.com/beta/education/users/{userId}"� + "@odata.id":"https://graph.microsoft.com/beta/education/users/14011"� } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationclass_update.md b/EDUGraphAPIs/Rostering/api/educationclass_update.md index 4b79baa7..d2085751 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_update.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_update.md @@ -1,4 +1,4 @@ -# Update educationclass +# Update educationclass properties Update the properties of a class. @@ -46,13 +46,13 @@ The following is an example of the request. "name": "update_educationclass" }--> ```http -PATCH https://graph.microsoft.com/beta/education/classes/ +PATCH https://graph.microsoft.com/beta/education/classes/11014 Content-type: application/json Content-length: 224 { - "description": "String", - "displayName": "String", + "description": "History - World History 1", + "displayName": "World History Level 1", } ``` ##### Response @@ -71,15 +71,20 @@ Content-type: application/json Content-length: 224 { - "id": "String", - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" + "id": "11014", + "description": "World History Level 1", + "classCode": "301", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "History - World History 1", + "externalId": "301", + "externalName": "World History Level 1", + "externalSource": "Fabrikam High School", + "mailNickname": "Fabrikam" } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md index f01b2bba..fb3ebd0d 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md @@ -58,15 +58,20 @@ Content-length: 277 { "value": [ { - "id": "String", - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md index 04002c90..277e2f76 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md @@ -57,22 +57,33 @@ Content-length: 345 { "value": [ { - "id": "String", - "displayName": "String", - "description": "String", - "status": "String", - "externalSource": "String", - "principalEmail": "String", - "principalName": "String", - "externalPrincipalId": "String", - "highestGrade": "String", - "lowestGrade": "String", - "schoolNumber": "String", - "address": {"@odata.type": "microsoft.graph.physicalAddress"}, - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalId": "String", - "fax": "String", - "phone": "String", + "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", + "fax": "+1 (253) 555-0101", + "phone": "+1 (253) 555-0102", } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md index c3aab9c4..aae17251 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md @@ -57,18 +57,35 @@ Content-length: 593 { "value": [ { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "13012", + "displayName": "Dion Matheson", + "givenName": "Dion", + "middleName": " ", + "surname": "Matheson", + "mail": "DionM@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": {"@odata.type": "microsoft.graph.identitySet"},{ + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + } + "externalSource": "sis", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "primaryRole": "student", + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md index 43ad5a5f..8ae41595 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md @@ -43,15 +43,21 @@ Content-type: application/json Content-length: 224 { - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" -} + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" + } ``` ##### Response @@ -70,16 +76,21 @@ Content-type: application/json Content-length: 224 { - "id": "String", - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" -} + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" + } ``` -```http -GET /education/schools +```http GET /education/schools ``` ## Optional query parameters This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response. diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md index aae17251..21f839e3 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md @@ -64,7 +64,7 @@ Content-length: 593 "surname": "Matheson", "mail": "DionM@contoso.com", "mobilePhone": "+1 (253) 555-0101", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"},{ + "createdBy": { "user": { "displayName": "Susana Rocha", "id": "14012", diff --git a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md index 8ae41595..3780c9d1 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md @@ -43,21 +43,14 @@ Content-type: application/json Content-length: 224 { - "id": "11019", - "description": "Health Level 1", - "classCode": "Health 501", - "createdBy": { - "user": { - "displayName": "Susana Rocha", - "id": "14012", - } - }, - "displayName": "Health 1", - "externalId": "11019", - "externalName": "Health Level 1", - "externalSource": "sis", - "mailNickname": "fineartschool.net" - } + "description": "Health Level 1", + "classCode": "Health 501", + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" +} ``` ##### Response @@ -76,21 +69,21 @@ Content-type: application/json Content-length: 224 { - "id": "11019", - "description": "Health Level 1", - "classCode": "Health 501", - "createdBy": { - "user": { - "displayName": "Susana Rocha", - "id": "14012", - } - }, - "displayName": "Health 1", - "externalId": "11019", - "externalName": "Health Level 1", - "externalSource": "sis", - "mailNickname": "fineartschool.net" - } + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" +} ``` ```http -DELETE https://graph.microsoft.com/beta/education/schools/ +DELETE https://graph.microsoft.com/beta/education/schools/10002 ``` ##### Response The following is an example of the response. diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md index 221a56dd..d6e8fda5 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md @@ -1,6 +1,6 @@ -# Delete educationClass +# Remove educationClass -Delete a class from a school. +Remove a class from a school. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -DELETE https://graph.microsoft.com/beta/education/schools//classes/{classId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/10001/classes/11001 ``` ##### Response diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md index f2181893..fef606bb 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md @@ -1,6 +1,6 @@ # Remove educationUser from an educationSchool -Delete a user from a school. +Remove a user from a school. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ Here is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -DELETE https://graph.microsoft.com/beta/education/schools/{id}/users/{userId}/$ref +DELETE https://graph.microsoft.com/beta/education/schools/10001/users/13006 ``` ##### Response diff --git a/EDUGraphAPIs/Rostering/api/educationschool_get.md b/EDUGraphAPIs/Rostering/api/educationschool_get.md index 381c2e83..95d94f80 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_get.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_get.md @@ -38,7 +38,7 @@ The following is an example of the request. "name": "get_educationschool" }--> ```http -GET https://graph.microsoft.com/beta/education/schools +GET https://graph.microsoft.com/beta/education/schools/10001 ``` ##### Response The following is an example of the response. @@ -56,12 +56,11 @@ Content-type: application/json Content-length: 292 { - "schoolZone": "schoolZone-value", - "schoolPrincipalEmail": "schoolPrincipalEmail-value", - "schoolPrincipalName": "schoolPrincipalName-value", - "externalSchoolPrincipalId": "externalSchoolPrincipalId-value", - "lowestGrade": "lowestGrade-value", - "highestGrade": "highestGrade-value" + "schoolPrincipalEmail": "AmyRoebuck@contoso.com", + "schoolPrincipalName": "Amy Roebuck", + "externalSchoolPrincipalId": "14007", + "lowestGrade": "9", + "highestGrade": "12" } ``` From e7e2d540366d84948255c1cce6df9dc8232624e3 Mon Sep 17 00:00:00 2001 From: John Austin Date: Fri, 17 Nov 2017 09:01:52 -0800 Subject: [PATCH 80/87] added sample data to json responses: exit e :wq :wq :wq :q! quit q wq wq --- .../api/educationclass_list_members.md | 1 - .../api/educationschool_list_classes.md | 27 +++++---- .../api/educationschool_list_users.md | 43 ++++++++++----- .../api/educationschool_post_classes.md | 6 +- .../api/educationschool_post_users.md | 4 +- .../Rostering/api/educationschool_update.md | 39 +++++++------ .../Rostering/api/educationuser_delete.md | 5 +- .../Rostering/api/educationuser_get.md | 46 +++++++++++----- .../api/educationuser_list_classes.md | 29 ++++++---- .../api/educationuser_list_schools.md | 46 ++++++++++------ .../Rostering/api/educationuser_update.md | 55 +++++++++++++------ 11 files changed, 191 insertions(+), 110 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md index ddb37980..f2fbc13a 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md @@ -116,7 +116,6 @@ Content-length: 593 "primaryRole": "student", "externalId": "13005", "birthDate": "2001-01-01T00:00:00Z", - "externalId": "123", "gender": "female", "grade": "9", "graduationYear": "2019", diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md index 561178db..7f749759 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md @@ -1,6 +1,6 @@ # List classes -Retrieve a list of classes owned by a school. +Retrieve a list of classes offered by a school. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "get_classes" }--> ```http -GET https://graph.microsoft.com/beta/education/schools//classes +GET https://graph.microsoft.com/beta/education/schools/10002/classes ``` ##### Response The following is an example of the response. @@ -57,15 +57,20 @@ Content-length: 277 { "value": [ { - "id": "String", - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md index a8c17eb6..21df2c83 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md @@ -36,7 +36,7 @@ The following is an example of the request. "name": "get_users" }--> ```http -GET https://graph.microsoft.com/beta/education/schools//users +GET https://graph.microsoft.com/beta/education/schools/10002/users ``` ##### Response The following is an example of the response. @@ -57,18 +57,35 @@ Content-length: 593 { "value": [ { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "13012", + "displayName": "Dion Matheson", + "givenName": "Dion", + "middleName": " ", + "surname": "Matheson", + "mail": "DionM@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + } + "externalSource": "sis", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "primaryRole": "student", + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + } } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md index f4f7fd3c..32b70abb 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md @@ -1,6 +1,6 @@ # Add educationClass to educationSchool -Add a class to a school. +Add a class from the root class collection to a school. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -37,12 +37,12 @@ The following is an example of the request. "name": "create_educationclass_from_educationschool" }--> ```http -POST https://graph.microsoft.com/beta/education/schools//classes/$ref +POST https://graph.microsoft.com/beta/education/schools/10002/classes/$ref Content-type: application/json Content-length: 224 { -� "@odata.id":"https://graph.microsoft.com/beta/education/classes/{classId}"� +� "@odata.id":"https://graph.microsoft.com/beta/education/classes/11006"� } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md index daaf07f6..a425f30c 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md @@ -1,6 +1,6 @@ # Add educationUser to an educationSchool -Add a user to a school. +Add a user from the root user collection to a school. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -42,7 +42,7 @@ Content-type: application/json Content-length: 56 { - "@odata.id":"https://graph.microsoft.com/beta/education/users/{userId}"� + "@odata.id":"https://graph.microsoft.com/beta/education/users/14008"� } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationschool_update.md b/EDUGraphAPIs/Rostering/api/educationschool_update.md index a1fc7968..9975c6ac 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_update.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_update.md @@ -51,13 +51,13 @@ The following is an example of the request. "name": "update_educationschool" }--> ```http -PATCH https://graph.microsoft.com/beta/education/schools/ +PATCH https://graph.microsoft.com/beta/education/schools/10002 Content-type: application/json Content-length: 292 { - "displayName": "String", - "description": "String", + "displayName": "Fabrikam Arts High School", + "description": "Magnate school for the arts. Los Angeles School District", } ``` ##### Response @@ -76,22 +76,27 @@ Content-type: application/json Content-length: 292 { - "id": "String", - "displayName": "String", - "description": "String", + "id": "10002" + "displayName": "Fabrikam Arts High School", + "description": "Magnate school for the arts. Los Angeles School District", "status": "String", "externalSource": "String", - "principalEmail": "String", - "principalName": "String", - "externalPrincipalId": "String", - "highestGrade": "String", - "lowestGrade": "String", - "schoolNumber": "String", - "address": {"@odata.type": "microsoft.graph.physicalAddress"}, - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalId": "String", - "fax": "String", - "phone": "String" + "principalEmail": "AmyR@fabrikam.com", + "principalName": "Amy Roebuck", + "externalPrincipalId": "14007", + "highestGrade": "12", + "lowestGrade": "9", + "schoolNumber": "10002", + "address": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "externalId": "10002", + "fax": "+1 (253) 555-0101", + "phone": "+1 (253) 555-0102", } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationuser_delete.md b/EDUGraphAPIs/Rostering/api/educationuser_delete.md index 46adb8ee..24f5c7e2 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_delete.md @@ -1,8 +1,7 @@ # Delete educationUser -Delete a user. +Delete an [educationUser](../resources/educationuser.md) from the Edu root **educationUser** collection. - ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -38,7 +37,7 @@ Here is an example of the request. "name": "delete_educationuser" }--> ```http -DELETE https://graph.microsoft.com/beta/education/users/ +DELETE https://graph.microsoft.com/beta/education/users/13019 ``` ##### Response The following is an example of the response. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_get.md b/EDUGraphAPIs/Rostering/api/educationuser_get.md index 41a62d44..4b2d819c 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_get.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_get.md @@ -1,6 +1,6 @@ # Get educationUser -Retrieve the properties and relationships of a user. +Retrieve the properties and relationships of an [educationUser](../resources/educationuser.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -36,7 +36,7 @@ The following is an example of the request. "name": "get_educationuser" }--> ```http -GET https://graph.microsoft.com/beta/education/users/ +GET https://graph.microsoft.com/beta/education/users/13012 ``` ##### Response The following is an example of the response. @@ -54,19 +54,35 @@ Content-type: application/json Content-length: 508 { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "teacher": {"@odata.type": "microsoft.graph.educationTeacher"} + "id": "13012", + "displayName": "Dion Matheson", + "givenName": "Dion", + "middleName": " ", + "surname": "Matheson", + "mail": "DionM@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + } + "externalSource": "sis", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "primaryRole": "student", + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md index db881275..1e9e7afd 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md @@ -1,6 +1,8 @@ # List classes -Retrieve a list of class objects. Note that if the delegated token is used, members can only see information about their own classes. +Retrieve the [educationClass](../resources/educationclass.md) objects that the specified **educationUser** belongs to. + +>**Note:** If the delegated token is used, members can only see information about their own classes. Use the `...beta/education/me/classes` resource in this case. @@ -60,16 +62,21 @@ Content-length: 277 { "value": [ { - "id": "String", - "description": "String", - "classCode": "String", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "displayName": "String", - "externalId": "String", - "externalName": "String", - "externalSource": "string", - "mailNickname": "String" - } + "id": "11019", + "description": "Health Level 1", + "classCode": "Health 501", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + } + }, + "displayName": "Health 1", + "externalId": "11019", + "externalName": "Health Level 1", + "externalSource": "sis", + "mailNickname": "fineartschool.net" + } ] } ``` diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md index 0d324ed6..820bafb0 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md @@ -1,6 +1,9 @@ # List schools Retrieve a list of schools for a user. + +>**Note:** If the delegated token is used, members can only see information about their own schools. Use the `...beta/education/me/schools` resource in this case. + ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). @@ -57,22 +60,33 @@ Content-length: 345 { "value": [ { - "id": "String", - "displayName": "String", - "description": "String", - "status": "String", - "externalSource": "String", - "principalEmail": "String", - "principalName": "String", - "externalPrincipalId": "String", - "highestGrade": "String", - "lowestGrade": "String", - "schoolNumber": "String", - "address": {"@odata.type": "microsoft.graph.physicalAddress"}, - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalId": "String", - "fax": "String", - "phone": "String", + "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", + "fax": "+1 (253) 555-0101", + "phone": "+1 (253) 555-0102", } ] } diff --git a/EDUGraphAPIs/Rostering/api/educationuser_update.md b/EDUGraphAPIs/Rostering/api/educationuser_update.md index 51852c85..635dc3d4 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_update.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_update.md @@ -52,15 +52,15 @@ Here is an example of the request. "name": "update_educationuser" }--> ```http -PATCH https://graph.microsoft.com/beta/education/users/ +PATCH https://graph.microsoft.com/beta/education/users/13020 Content-type: application/json Content-length: 508 { - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", + "displayName": "Rogelio Cazares", + "givenName": "Rogelio", + "middleName": "Fernando", + "surname": "Cazares", } ``` ##### Response @@ -76,20 +76,39 @@ Content-type: application/json Content-length: 508 { - "id": "string", - "displayName": "string", - "givenName": "string", - "middleName": "string", - "surname": "string", - "mail": "string", - "mobilePhone": "string", - "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, - "externalSource": "string", - "mailingAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, + "id": "13020", + "displayName": "Rogelio Cazares", + "givenName": "Rogelio", + "middleName": "Fernando", + "surname": "Cazares", + "mail": "rogelioC@contoso.com", + "mobilePhone": "+1 (253) 555-0101", + "createdBy": { + "user": { + "displayName": "Susana Rocha", + "id": "14012", + }, + "externalSource": "sis", + "mailingAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, "primaryRole": "string", - "residenceAddress": {"@odata.type": "microsoft.graph.physicalAddress"}, - "student": {"@odata.type": "microsoft.graph.educationStudent"}, - "teacher": {"@odata.type": "microsoft.graph.educationTeacher"} + "residenceAddress": { + "city": "Los Angeles", + "countryOrRegion": "United States", + "postalCode": "98055", + "state": "CA", + "street": "12345 Main St." + }, + "student": { + "primaryRole": "student", + "externalId": "13005", + "birthDate": "2001-01-01T00:00:00Z" + } } ``` From e8335ddfa7059491d3523e01e9d187bf1f48511e Mon Sep 17 00:00:00 2001 From: John Austin Date: Fri, 17 Nov 2017 10:39:41 -0800 Subject: [PATCH 81/87] merged changes from upstream --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 6 ------ .../Rostering/api/educationclass_delete_teachers.md | 6 ------ 2 files changed, 12 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 2d2f3dbd..6f09157a 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,12 +1,6 @@ -<<<<<<< HEAD # Remove a student from a class roster Removes a student from a class roster. an [educationUser](../resources/educationuser.md) with a **primaryRole** of `student` from an [educationClass](../resources/educationclass.md) -======= -# Remove educationUser (student) - -Remove a student from a class. ->>>>>>> 121ca8792ac7ab9dd2716b939b1bfc3dfcc0b4f2 ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index 81d4ca8c..8bcc30ff 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,12 +1,6 @@ -<<<<<<< HEAD # Remove a teacher Remove an [educationUser](../resources/educationuser.md) with a **primaryRole** of `teacher` from an [educationClass](../resources/educationclass.md) -======= -# Remove educationUser (teacher) - -Remove a teacher from a class. ->>>>>>> 121ca8792ac7ab9dd2716b939b1bfc3dfcc0b4f2 ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 2b677752c96f66802f63f4c54ffbbc573ca84d3d Mon Sep 17 00:00:00 2001 From: John Austin Date: Fri, 17 Nov 2017 10:51:45 -0800 Subject: [PATCH 82/87] merged from local master --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 6 ------ .../Rostering/api/educationclass_delete_teachers.md | 6 ------ 2 files changed, 12 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 2d2f3dbd..6f09157a 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,12 +1,6 @@ -<<<<<<< HEAD # Remove a student from a class roster Removes a student from a class roster. an [educationUser](../resources/educationuser.md) with a **primaryRole** of `student` from an [educationClass](../resources/educationclass.md) -======= -# Remove educationUser (student) - -Remove a student from a class. ->>>>>>> 121ca8792ac7ab9dd2716b939b1bfc3dfcc0b4f2 ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index 81d4ca8c..8bcc30ff 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,12 +1,6 @@ -<<<<<<< HEAD # Remove a teacher Remove an [educationUser](../resources/educationuser.md) with a **primaryRole** of `teacher` from an [educationClass](../resources/educationclass.md) -======= -# Remove educationUser (teacher) - -Remove a teacher from a class. ->>>>>>> 121ca8792ac7ab9dd2716b939b1bfc3dfcc0b4f2 ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). From 13bdb7640643eccb178954a0e6bec3e75c531505 Mon Sep 17 00:00:00 2001 From: John Austin Date: Fri, 17 Nov 2017 11:06:44 -0800 Subject: [PATCH 83/87] fixed title of remove student from class --- EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 6f09157a..c779d59d 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,4 +1,4 @@ -# Remove a student from a class roster +# Remove a student Removes a student from a class roster. an [educationUser](../resources/educationuser.md) with a **primaryRole** of `student` from an [educationClass](../resources/educationclass.md) From 7348ff1dcaf9ae564bdb1a14d156af12fa655f0d Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 20 Nov 2017 14:08:15 -0800 Subject: [PATCH 84/87] Added beta disclaimer. --- EDUGraphAPIs/Assignments/api/educationassignment_delete.md | 2 ++ EDUGraphAPIs/Assignments/api/educationassignment_get.md | 2 ++ .../api/educationassignment_getResourcesFolderUrl.md | 2 ++ .../Assignments/api/educationassignment_list_resources.md | 2 ++ .../Assignments/api/educationassignment_list_submissions.md | 2 ++ .../Assignments/api/educationassignment_post_resources.md | 2 ++ EDUGraphAPIs/Assignments/api/educationassignment_publish.md | 2 ++ EDUGraphAPIs/Assignments/api/educationassignment_update.md | 2 ++ .../Assignments/api/educationassignmentresource_delete.md | 2 ++ .../Assignments/api/educationassignmentresource_get.md | 2 ++ .../Assignments/api/educationassignmentresource_update.md | 2 ++ .../Assignments/api/educationclass_list_assignments.md | 2 ++ .../Assignments/api/educationclass_post_assignments.md | 2 ++ EDUGraphAPIs/Assignments/api/educationsubmission_get.md | 2 ++ .../Assignments/api/educationsubmission_list_resources.md | 4 ++-- .../api/educationsubmission_list_submittedresources.md | 2 ++ .../Assignments/api/educationsubmission_post_resources.md | 2 ++ EDUGraphAPIs/Assignments/api/educationsubmission_recall.md | 2 ++ EDUGraphAPIs/Assignments/api/educationsubmission_release.md | 2 ++ EDUGraphAPIs/Assignments/api/educationsubmission_submit.md | 2 ++ EDUGraphAPIs/Assignments/api/educationsubmission_update.md | 2 ++ .../Assignments/api/educationsubmissionresource_delete.md | 2 ++ .../Assignments/api/educationsubmissionresource_get.md | 2 ++ .../api/educationsubmittedsubmissionresource_get.md | 2 ++ .../Assignments/api/educationuser_list_assignments.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationassignment.md | 2 ++ .../resources/educationassignmentclassrecipient.md | 2 ++ .../Assignments/resources/educationassignmentgrade.md | 2 ++ .../Assignments/resources/educationassignmentgradetype.md | 2 ++ .../Assignments/resources/educationassignmentpointsgrade.md | 2 ++ .../resources/educationassignmentpointsgradetype.md | 2 ++ .../Assignments/resources/educationassignmentrecipient.md | 2 ++ .../Assignments/resources/educationassignmentresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationexcelresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationfeedback.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationfileresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationlinkresource.md | 2 ++ .../Assignments/resources/educationonenoteresource.md | 2 ++ .../Assignments/resources/educationpowerpointresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationsubmission.md | 2 ++ .../resources/educationsubmissionindividualrecipient.md | 2 ++ .../Assignments/resources/educationsubmissionrecipient.md | 2 ++ .../Assignments/resources/educationsubmissionresource.md | 2 ++ EDUGraphAPIs/Assignments/resources/educationwordresource.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_delete.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_delete_members.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_get.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_list_members.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_list_schools.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_post_members.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md | 2 ++ EDUGraphAPIs/Rostering/api/educationclass_update.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_list_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_list_schools.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_list_users.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_post_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_post_schools.md | 2 ++ EDUGraphAPIs/Rostering/api/educationroot_post_users.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_delete.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_delete_users.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_get.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_list_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_list_users.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_post_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_post_users.md | 2 ++ EDUGraphAPIs/Rostering/api/educationschool_update.md | 2 ++ EDUGraphAPIs/Rostering/api/educationuser_delete.md | 2 ++ EDUGraphAPIs/Rostering/api/educationuser_get.md | 2 ++ EDUGraphAPIs/Rostering/api/educationuser_list_classes.md | 2 ++ EDUGraphAPIs/Rostering/api/educationuser_list_schools.md | 2 ++ EDUGraphAPIs/Rostering/api/educationuser_update.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationclass.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationorganization.md | 1 + EDUGraphAPIs/Rostering/resources/educationroot.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationschool.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationstudent.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationteacher.md | 1 + EDUGraphAPIs/Rostering/resources/educationterm.md | 2 ++ EDUGraphAPIs/Rostering/resources/educationuser.md | 2 ++ EDUGraphAPIs/education-overview.md | 2 ++ 84 files changed, 166 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md index 542fd23f..513b7bf6 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_delete.md @@ -1,5 +1,7 @@ # Delete educationAssignment +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete an existing assignment. Only teachers within a class can delete assignments. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_get.md b/EDUGraphAPIs/Assignments/api/educationassignment_get.md index a22cc03e..9253bf6e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_get.md @@ -1,5 +1,7 @@ # Get educationAssignment +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Get the properties and relationships of an assignment. Students can only see assignments assigned to them; teachers can see all assignments in a class. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md index c45180d0..e82749f5 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_getResourcesFolderUrl.md @@ -1,5 +1,7 @@ # educationAssignment: getResourcesFolderUrl +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + This function returns the OneDrive URL where all file-based resources (Word, Excel, and so on) should be uploaded. Note that files must be located in this folder in order to be added as resources. Only a teacher in the class can determine what files to upload. diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md index 58a180fd..0c2db927 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_resources.md @@ -1,5 +1,7 @@ # List resources +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Get all the resources associated with this assignment. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md index e19550ea..f0cfef4d 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md @@ -1,5 +1,7 @@ # List submissions +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + List all the submissions associated with this assignment. A teacher can get all the submissions while a student can only get submissions that they are associated with. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md index 635d62b8..aade75ce 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_post_resources.md @@ -1,5 +1,7 @@ # Create educationAssignmentResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Create an [assignment resource](../resources/educationassignmentresource.md). The resource itself has an @odata.type to indicate which type of resource is being created. Note that file-based resources must first be uploaded to the assignments **resourceFolder**. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md index 3b19a167..08258f2e 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_publish.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_publish.md @@ -1,5 +1,7 @@ # educationAssignment: publish +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + This action changes the state of an assignment from its original draft status to the published status. Only a teacher in the class can make this call. When an assignment is in draft status, students will not see the assignment, nor will there be any submission objects. When you call this API, submission objects are created and the assignment appears in the student's list. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_update.md b/EDUGraphAPIs/Assignments/api/educationassignment_update.md index 9b30b31e..2c72ec28 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_update.md @@ -1,5 +1,7 @@ # Update educationassignment +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Update the assignment object. Only teachers in the class can do this. Note that you can't use a PATCH request to change the status of an assignment. Use the [publish](../api/educationassignment_publish.md) action to change the assignment status. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md index 289c4f47..7ad70c70 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_delete.md @@ -1,5 +1,7 @@ # Delete educationAssignmentResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a resource from an assignment. Only teachers in the class can remove a resource. After an assignment has been published to students, teachers cannot remove resources that are marked as "distributeToStudents". ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md index 383becda..fee2fb3c 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_get.md @@ -1,5 +1,7 @@ # Get educationAssignmentResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Get the properties of a specific resource on an assignment. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md index 8f4fb47f..92efdd63 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md +++ b/EDUGraphAPIs/Assignments/api/educationassignmentresource_update.md @@ -1,5 +1,7 @@ # Update educationassignmentresource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Update the properties of resource associated with an assignment. Only teachers in a class can change assignment resource objects. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md index 37c0fbf2..b5ceb8fe 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_list_assignments.md @@ -1,5 +1,7 @@ # List assignments +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of assignment objects. A teacher is allowed to see all assignment objects for the class. Students can only see assignments that are assigned to them. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md index a789c7cb..47d5ae59 100644 --- a/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationclass_post_assignments.md @@ -1,5 +1,7 @@ # Create educationAssignment +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Creates a new assignment. Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publish is called. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md index 7cf1a726..026145ad 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_get.md @@ -1,5 +1,7 @@ # Get educationSubmission +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a particular submission. A submission object represents a student's work for an assignment. Resources associated with the submission represent this work. Only the student the submission is assigned to can see and modify the submission. A teacher has full access to all submissions. The grade and feedback from a teacher are also part of this object. Only teachers can add or change grades and feedback. Students will not see the grade or feedback until the assignment has been released. The Basic permissions do not include grade and feedback but do include everything else. diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md index 1d8d1b92..83af1f9a 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md @@ -1,8 +1,8 @@ # List resources -List the resources associated with this submission. The **submissionResource** object is a wrapper around the actual resource object the student is working on. The wrapper also includes a pointer to the resources on the assignment if this was copied from the assignment during the assign process. These resources are the working copy of the assignment. The **submittedResources** are the resources that have officially been submitted to be graded. +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. - +List the resources associated with this submission. The **submissionResource** object is a wrapper around the actual resource object the student is working on. The wrapper also includes a pointer to the resources on the assignment if this was copied from the assignment during the assign process. These resources are the working copy of the assignment. The **submittedResources** are the resources that have officially been submitted to be graded. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md index 0e1b04b2..c803e6b9 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md @@ -1,5 +1,7 @@ # List submittedResources +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + List the resources that have officially been submitted for grading. The student who owns the submission cannot change the submitted list without resubmitting the assignment. This is a wrapper around the real resource and can contain a pointer back to the actual assignment resource if this resource was copied from the assignment. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md index fe564b53..4e164849 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_post_resources.md @@ -1,5 +1,7 @@ # Create educationSubmissionResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Adds a resource to the resources list. This action can only be done by the student to whom this submission is assigned. This action will not succeed if the **allowStudentsToAddResources** flag is not set to true. If the caller wants to create a new file-based resource, the file must be uploaded to the resources folder that is associated with the submission. If the file does not exist or is not in that folder, the POST request will fail. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md index b05f5658..fb4c9ddd 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_recall.md @@ -1,5 +1,7 @@ # educationSubmission: recall +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Indicates that a student wants to take back a submission. This action can only be done by a student. It will change the status of the submission from "submitted" back to "working". ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md index f6784d4e..2ccd7329 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_release.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_release.md @@ -1,5 +1,7 @@ # educationSubmission: release +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + This action makes the grade and feedback associated with this submission available to the student. This will change the status of the submission from "submitted" to "released" and indicates that grading is done. This action can only be done by the teacher. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md index 93ba33c4..34cbefb4 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_submit.md @@ -1,5 +1,7 @@ # educationSubmission: submit +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + An action that indicates that a student is done with the work and is ready to hand in the assignment. This action can only be taken by the student. This will change the status of the submission from "working" to "submitted". During the submit process, all the resources will be copied to the submittedResources bucket. The teacher will be looking at the submitted resources list for grading. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md index 1a15fe20..ff3a3089 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_update.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_update.md @@ -1,5 +1,7 @@ # Update educationsubmission +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Add a grade and feedback to a submission. Only teachers can perform this operation. Note that the Basic permission does not have access to the grade properties, and therefore cannot write to grade or feedback. This action does not release the grade and feedback to the student. A teacher must take an explicit release action for the grade data to be returned to the student. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md index 55a2538e..90f1ccf8 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_delete.md @@ -1,5 +1,7 @@ # Delete educationSubmissionResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Deletes a resource from the submission. This can only be done by the student. If the resource was copied from the assignment, a new copy of the resource will be created after the current copy is deleted. This allows you to "reset" the resource to its original state. If the resource was not copied from the assignment but was added from the student, the resource is simply deleted. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md index 4a71d435..92690d6b 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmissionresource_get.md @@ -1,5 +1,7 @@ # Get educationSubmissionResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieves the properties of a specific resource associated with the submission. This resource is in the "working" resource list and should be considered work in process by a student. This resource is wrapped with a possible pointer back to the assignment resource if it was copied from the assignment. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md index 894bfa44..20b70d95 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmittedsubmissionresource_get.md @@ -1,5 +1,7 @@ # Get educationSubmittedSubmissionResource +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Returns a submitted resource. This will be available to a teacher after a student has submitted, and will be available to the student after the teacher has released the submission. Note that teachers can leave notes in some resources. ## Permissions diff --git a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md index 723af8c4..e7732db8 100644 --- a/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md +++ b/EDUGraphAPIs/Assignments/api/educationuser_list_assignments.md @@ -1,5 +1,7 @@ # List assignments +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Returns a list of assignments assigned to a user for all classes. This utility namespace allows a caller to find all a student's assignments in a single call rather than having to request assignments from each class. The assignment list contains what is needed to get the detailed information for the assignment from within the class namespace. All other operations on the assignment should use the class namespace. ## Permissions diff --git a/EDUGraphAPIs/Assignments/resources/educationassignment.md b/EDUGraphAPIs/Assignments/resources/educationassignment.md index 428a8454..7c401e2b 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignment.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignment.md @@ -1,5 +1,7 @@ # educationAssignment resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + The **educationAssignment** resource represents a task or unit of work assigned to a student or team member in a class as part of their study. Only teachers or team owners can create assignments. Assignments contain handouts and tasks that the teacher wants the student to work on. Each student assignment has an associated [submission](educationsubmissionresource.md) that contains any work their teacher asked to be turned in. A teacher can add scores and feedback to the submission turned in by the student. When an assignment is created, it is in a Draft state. Students can't see the assignment and submissions won't be created. You can change the status of an assignment by using the [publish](../api/educationassignment_publish.md) action. You can't use a PATCH request to change the assignment status. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md index e5b5ca60..d00c0516 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentclassrecipient.md @@ -1,5 +1,7 @@ # educationAssignmentClassRecipient resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Used inside the [assignment.assignTo](educationassignment.md) property. When set to class recipient, every student in the class will receive a submission object when the assignment is published. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md index bd518432..375fa33d 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentgrade.md @@ -1,5 +1,7 @@ # educationAssignmentGrade resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Represents the **Grade** object on a Submission. This is an abstract type that will never be instantiated; however, all types of grading (points, pass/fail, and so on) are subclasses of this resource type. This object also tracks who is doing the grading. This is used in the **submission.grade** property. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentgradetype.md b/EDUGraphAPIs/Assignments/resources/educationassignmentgradetype.md index e9e6f659..8351a114 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentgradetype.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentgradetype.md @@ -1,5 +1,7 @@ # educationAssignmentGradeType resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Represents how an assignment will be graded. This is used within the **assignments.grading** property. This superclass can not be used directly in the assignment property. It exists to allow for multiple different ways to grade assignments. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md index 2474d6f8..5d8f2677 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgrade.md @@ -1,5 +1,7 @@ # educationAssignmentPointsGrade resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + When an assignment is set to a points grade type, each submission will have this object associated with the **submission.grade** property. This creates a subclass from [educationAssignmentGrade](educationAssignmentGrade.md), which will add the who data to this property. The max points is stored in the **assignments.grading** property. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgradetype.md b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgradetype.md index aca02e3a..7273f27d 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgradetype.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentpointsgradetype.md @@ -1,5 +1,7 @@ # educationAssignmentPointsGradeType resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Used with the **assignments.grading** property. This is a subclass of [educationAssignmentGradeType](educationassignmentgradetype.md). This indicates that the assignment is graded and stores the maximum number of points each student can achieve on this work item. When this is set on an assignment, each submission will get diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentrecipient.md b/EDUGraphAPIs/Assignments/resources/educationassignmentrecipient.md index 05518b4c..7ea11301 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentrecipient.md @@ -1,5 +1,7 @@ # educationAssignmentRecipient resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Used within the **assignments.assignTo** property. This superclass is abstract and you cannot set the property in assignments to this value. This superclass represents who the assignment should be assigned to when the assignment is published. diff --git a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md index 27ec53ef..1f030068 100644 --- a/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationassignmentresource.md @@ -1,5 +1,7 @@ # educationAssignmentResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will be copied to the student submission. If the object is not copied, each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student will receive a copy of this resource in the resource list of their submission. Each student will be able to modify their copy and submit it for grading. diff --git a/EDUGraphAPIs/Assignments/resources/educationexcelresource.md b/EDUGraphAPIs/Assignments/resources/educationexcelresource.md index 2d5fd2b6..c32afe76 100644 --- a/EDUGraphAPIs/Assignments/resources/educationexcelresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationexcelresource.md @@ -1,5 +1,7 @@ # educationExcelResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md). This resource type represents an Excel document. >**Note:** The Excel file must be in the resource folder associated with the assignment diff --git a/EDUGraphAPIs/Assignments/resources/educationfeedback.md b/EDUGraphAPIs/Assignments/resources/educationfeedback.md index 8bf508ec..c348246a 100644 --- a/EDUGraphAPIs/Assignments/resources/educationfeedback.md +++ b/EDUGraphAPIs/Assignments/resources/educationfeedback.md @@ -1,5 +1,7 @@ # educationFeedback resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Feedback from a teacher to a student. This property represents both the text part of the feedback along with the who. diff --git a/EDUGraphAPIs/Assignments/resources/educationfileresource.md b/EDUGraphAPIs/Assignments/resources/educationfileresource.md index e60f09a1..4423ebc5 100644 --- a/EDUGraphAPIs/Assignments/resources/educationfileresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationfileresource.md @@ -1,5 +1,7 @@ # educationFileResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md) that represents a file object that is associated with the assignment or submission. In this case, the file is not one of the special files (Word, Excel, and so on) but is a file that does not have special handling within the system. The file resource must be stored in the **resourceFolder** that is associated with the assignment or submission this resource is attached to. ## Properties diff --git a/EDUGraphAPIs/Assignments/resources/educationlinkresource.md b/EDUGraphAPIs/Assignments/resources/educationlinkresource.md index c6c4db1e..cfaf46d0 100644 --- a/EDUGraphAPIs/Assignments/resources/educationlinkresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationlinkresource.md @@ -1,5 +1,7 @@ # educationLinkResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md). This resource is a link and does not have any additional data associated with it. diff --git a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md index 0871993e..cbed7fbd 100644 --- a/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationonenoteresource.md @@ -1,5 +1,7 @@ # educationOneNoteResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md). This represents the location of the OneNote page. ## Properties diff --git a/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md b/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md index 27153428..b185a282 100644 --- a/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationpowerpointresource.md @@ -1,5 +1,7 @@ # educationPowerPointResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md). This is a PowerPoint resource. The PowerPoint file must be uploaded in the **fileResource** directory associated with the assignment or submission. diff --git a/EDUGraphAPIs/Assignments/resources/educationresource.md b/EDUGraphAPIs/Assignments/resources/educationresource.md index ac956c12..c9ab22ef 100644 --- a/EDUGraphAPIs/Assignments/resources/educationresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationresource.md @@ -1,5 +1,7 @@ # educationResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A superclass for all resource objects in the system. A resource is associated with an **Assignment** and/or **Submission**, which represents the learning object that is being handed out or handed in. You cannot instantiate a resource directly; you must make a subclass that will represent the type of resource being used. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmission.md b/EDUGraphAPIs/Assignments/resources/educationsubmission.md index 29e9e60f..366b5051 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmission.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmission.md @@ -1,5 +1,7 @@ # educationSubmission resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Submissions are owned by an assignment. A submission represents the resources that an individual (or group) turn in for an assignment and the grade/feedback that is returned. Submissions are automatically created when an assignment is published. The submission owns two lists of resources. Resources represent the user/groups working area while the submitted resources represent the resources that have actively been turned in by students. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmissionindividualrecipient.md b/EDUGraphAPIs/Assignments/resources/educationsubmissionindividualrecipient.md index 923ac25c..7bb8013f 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmissionindividualrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmissionindividualrecipient.md @@ -1,5 +1,7 @@ # educationSubmissionIndividualRecipient resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationSubmissionRecipient](educationsubmissionrecipient.md) that indicates that a submission is assigned to an individual in the class. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmissionrecipient.md b/EDUGraphAPIs/Assignments/resources/educationsubmissionrecipient.md index e8f1ba20..788cb098 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmissionrecipient.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmissionrecipient.md @@ -1,5 +1,7 @@ # educationSubmissionRecipient resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Abstract class that represents the different sets of users to whom a submission can be assigned. Possible values include individuals or groups. This is used within the **submission.recipient** property. diff --git a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md index a4b643da..6abd061e 100644 --- a/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationsubmissionresource.md @@ -1,5 +1,7 @@ # educationSubmissionResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A wrapper around a resource for use on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment. diff --git a/EDUGraphAPIs/Assignments/resources/educationwordresource.md b/EDUGraphAPIs/Assignments/resources/educationwordresource.md index 4987860a..c1be5939 100644 --- a/EDUGraphAPIs/Assignments/resources/educationwordresource.md +++ b/EDUGraphAPIs/Assignments/resources/educationwordresource.md @@ -1,5 +1,7 @@ # educationWordResource resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A subclass of [educationResource](educationresource.md). This is a Word document resource. The Word file must be uploaded in the **fileResource** directory associated with the assignment or submission. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete.md b/EDUGraphAPIs/Rostering/api/educationclass_delete.md index f1876bac..ee792c1f 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete.md @@ -1,5 +1,7 @@ # Delete educationClass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a class. Because a class is also a universal group, deleting a class deletes the group. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md index 5461d3c3..f49dd440 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_members.md @@ -1,5 +1,7 @@ # Remove educationUser (student) +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Remove a student from a class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md index 53627d2c..0e34245c 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_delete_teachers.md @@ -1,5 +1,7 @@ # Remove educationUser (teacher) +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Remove a teacher from a class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_get.md b/EDUGraphAPIs/Rostering/api/educationclass_get.md index b1754823..d126f6e9 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_get.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_get.md @@ -1,5 +1,7 @@ # Get educationClass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a class from the system. A class is a universal group with a special property that indicates to the system that the group is a class. Group members represent the students; group admins represent the teachers in the class. If you're using the delegated token, the user will only see classes in which they are members. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md index 7461e9f2..176db264 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md @@ -1,5 +1,7 @@ # List members +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieves the teachers and students for a class. Note that if the delegated token is used, members can only be seen by other members of the class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 6d751e38..d81cc033 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -1,5 +1,7 @@ # List schools +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of schools in which the class is taught. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 55d1e588..042ea2e3 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -1,5 +1,7 @@ # List teachers +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list teachers for a class. Delegated tokens must be members of the class to get the teacher list. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md index 1ba3240a..093d25ab 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md @@ -1,5 +1,7 @@ # Create educationUser (member) +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Add a member to a class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md index d9fe81b0..faf28600 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md @@ -1,5 +1,7 @@ # Create educationUser (teacher) +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Add a teacher to a class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationclass_update.md b/EDUGraphAPIs/Rostering/api/educationclass_update.md index 4b79baa7..340dcbe1 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_update.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_update.md @@ -1,5 +1,7 @@ # Update educationclass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Update the properties of a class. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md index f01b2bba..31283ce2 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md @@ -1,5 +1,7 @@ # List classes +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of all class objects. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md index 04002c90..1c654bd2 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md @@ -1,5 +1,7 @@ # List schools +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of all school objects. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md index c3aab9c4..3908b9f1 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md @@ -1,5 +1,7 @@ # List users +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of user objects. These user objects will include education-specific properties. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md index 43ad5a5f..a291f6c4 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_post_classes.md @@ -1,5 +1,7 @@ # Create educationClass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Create a new class. This will also create a universal group. When you use this API to create a class, it will add special properties to the group, which will add features such as assignments and special handling within Microsoft Teams. diff --git a/EDUGraphAPIs/Rostering/api/educationroot_post_schools.md b/EDUGraphAPIs/Rostering/api/educationroot_post_schools.md index a0d1d8e7..2d069423 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_post_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_post_schools.md @@ -1,5 +1,7 @@ # Create educationSchool +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Create a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationroot_post_users.md b/EDUGraphAPIs/Rostering/api/educationroot_post_users.md index 1e73a7b3..460c0ee2 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_post_users.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_post_users.md @@ -1,5 +1,7 @@ # Create educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Create a new user. diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete.md b/EDUGraphAPIs/Rostering/api/educationschool_delete.md index e3c3c5f5..095f56e9 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete.md @@ -1,5 +1,7 @@ # Delete educationSchool +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md index 221a56dd..626ed798 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_classes.md @@ -1,5 +1,7 @@ # Delete educationClass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a class from a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md index 5deeddeb..6a5df2cd 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_delete_users.md @@ -1,5 +1,7 @@ # Delete educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a user from a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_get.md b/EDUGraphAPIs/Rostering/api/educationschool_get.md index 381c2e83..4793420d 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_get.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_get.md @@ -1,5 +1,7 @@ # Get educationSchool +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve the properties and relationships of the school object. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md index 561178db..51def2bb 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md @@ -1,5 +1,7 @@ # List classes +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of classes owned by a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md index a8c17eb6..e2e2e2a8 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md @@ -1,5 +1,7 @@ # List users +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of users at a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md index 0c88fd06..8c993df3 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_classes.md @@ -1,5 +1,7 @@ # Create educationClass +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Add a class to a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md index 19e57a37..e7cc53fb 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_post_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_post_users.md @@ -1,5 +1,7 @@ # Create educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Add a user to a school. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationschool_update.md b/EDUGraphAPIs/Rostering/api/educationschool_update.md index b077d57a..36549d5a 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_update.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_update.md @@ -1,5 +1,7 @@ # Update educationschool +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Update the properties of a school object. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationuser_delete.md b/EDUGraphAPIs/Rostering/api/educationuser_delete.md index 46adb8ee..ad4a9bbe 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_delete.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_delete.md @@ -1,5 +1,7 @@ # Delete educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Delete a user. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_get.md b/EDUGraphAPIs/Rostering/api/educationuser_get.md index 41a62d44..3ab4cadb 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_get.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_get.md @@ -1,5 +1,7 @@ # Get educationUser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve the properties and relationships of a user. ## Permissions diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md index db881275..52fbf531 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md @@ -1,5 +1,7 @@ # List classes +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of class objects. Note that if the delegated token is used, members can only see information about their own classes. diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md index 0d324ed6..e007f3ba 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md @@ -1,5 +1,7 @@ # List schools +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Retrieve a list of schools for a user. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Rostering/api/educationuser_update.md b/EDUGraphAPIs/Rostering/api/educationuser_update.md index f49a6453..481cb762 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_update.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_update.md @@ -1,5 +1,7 @@ # Update educationuser +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Update the properties of an **educationuser** object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](../../../concepts/permissions_reference.md). diff --git a/EDUGraphAPIs/Rostering/resources/educationclass.md b/EDUGraphAPIs/Rostering/resources/educationclass.md index 58dea31c..8ad26fe9 100644 --- a/EDUGraphAPIs/Rostering/resources/educationclass.md +++ b/EDUGraphAPIs/Rostering/resources/educationclass.md @@ -1,5 +1,7 @@ # educationClass resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Represents a class within a school. The **educationClass** resource corresponds to the Office 365 group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections. diff --git a/EDUGraphAPIs/Rostering/resources/educationorganization.md b/EDUGraphAPIs/Rostering/resources/educationorganization.md index 048772a6..7eb6b906 100644 --- a/EDUGraphAPIs/Rostering/resources/educationorganization.md +++ b/EDUGraphAPIs/Rostering/resources/educationorganization.md @@ -1,5 +1,6 @@ # educationOrganization resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. Abstract entity used to model the commonality between different organization types within the education sector. diff --git a/EDUGraphAPIs/Rostering/resources/educationroot.md b/EDUGraphAPIs/Rostering/resources/educationroot.md index d7b51622..7829da24 100644 --- a/EDUGraphAPIs/Rostering/resources/educationroot.md +++ b/EDUGraphAPIs/Rostering/resources/educationroot.md @@ -1,5 +1,7 @@ # educationRoot resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + The `/education` namespace exposes functionality that is specific to the education sector. Some objects in the `/education` namespace can be found in other parts of Microsoft Graph (for example, [users](user.md)). The education namespace provides education-specific properties and features on these objects. diff --git a/EDUGraphAPIs/Rostering/resources/educationschool.md b/EDUGraphAPIs/Rostering/resources/educationschool.md index 6df5a608..afc61934 100644 --- a/EDUGraphAPIs/Rostering/resources/educationschool.md +++ b/EDUGraphAPIs/Rostering/resources/educationschool.md @@ -1,5 +1,7 @@ # educationSchool resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A school. The **educationSchool** resource currently corresponds to an [administrativeUnit](administrativeunit.md) resource and shares the same ID. This resource is a subtype of [educationOrganization](educationorganization.md). diff --git a/EDUGraphAPIs/Rostering/resources/educationstudent.md b/EDUGraphAPIs/Rostering/resources/educationstudent.md index 08e67684..4bfabd7e 100644 --- a/EDUGraphAPIs/Rostering/resources/educationstudent.md +++ b/EDUGraphAPIs/Rostering/resources/educationstudent.md @@ -1,5 +1,7 @@ # educationStudent resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + Additional information added to an [educationUser](educationuser.md) that is present when the primaryRole of a user is `student`. ## Properties diff --git a/EDUGraphAPIs/Rostering/resources/educationteacher.md b/EDUGraphAPIs/Rostering/resources/educationteacher.md index 548c6e4c..c0d04349 100644 --- a/EDUGraphAPIs/Rostering/resources/educationteacher.md +++ b/EDUGraphAPIs/Rostering/resources/educationteacher.md @@ -1,5 +1,6 @@ # educationTeacher resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. Additional information added to an [educationUser](educationuser.md) that is present when the primaryRole of a user is `teacher`. diff --git a/EDUGraphAPIs/Rostering/resources/educationterm.md b/EDUGraphAPIs/Rostering/resources/educationterm.md index 88710a69..93d3e2ed 100644 --- a/EDUGraphAPIs/Rostering/resources/educationterm.md +++ b/EDUGraphAPIs/Rostering/resources/educationterm.md @@ -1,5 +1,7 @@ # educationTerm resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A term. This represents a designated portion of the academic year. It is used within [educationClass](educationclass.md). ## Properties diff --git a/EDUGraphAPIs/Rostering/resources/educationuser.md b/EDUGraphAPIs/Rostering/resources/educationuser.md index cf04ad48..81d09015 100644 --- a/EDUGraphAPIs/Rostering/resources/educationuser.md +++ b/EDUGraphAPIs/Rostering/resources/educationuser.md @@ -1,5 +1,7 @@ # educationUser resource type +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + A user in the system. This is an education-specific variant of the user with the same `id` that Microsoft Graph will return from the non-education-specific `/users` endpoint. This object provides a targeted subset of properties from the core [user](user.md) object and adds a set of education-specific properties such as primaryRole, student, and teacher data. diff --git a/EDUGraphAPIs/education-overview.md b/EDUGraphAPIs/education-overview.md index f090c52a..67d6b69a 100644 --- a/EDUGraphAPIs/education-overview.md +++ b/EDUGraphAPIs/education-overview.md @@ -1,5 +1,7 @@ # Working with education APIs in Microsoft Graph +> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. + The education APIs in Microsoft Graph enhance Office 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources. The education APIs include rostering resources and assignments resources that you can use to interact with the rostering and assignment services in Microsoft Teams. You can use these resources to manage a school roster and automate student assignments. From d266b49d1e74bcbd8413dafc31152dd6a068740f Mon Sep 17 00:00:00 2001 From: John Austin Date: Mon, 20 Nov 2017 15:39:52 -0800 Subject: [PATCH 85/87] corrected list examples --- .../Assignments/api/educationassignment_list_submissions.md | 2 +- .../Assignments/api/educationsubmission_list_resources.md | 2 +- .../api/educationsubmission_list_submittedresources.md | 2 +- EDUGraphAPIs/Rostering/api/educationclass_list_members.md | 2 +- EDUGraphAPIs/Rostering/api/educationclass_list_schools.md | 2 +- EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md | 2 +- EDUGraphAPIs/Rostering/api/educationroot_list_classes.md | 2 +- EDUGraphAPIs/Rostering/api/educationroot_list_schools.md | 2 +- EDUGraphAPIs/Rostering/api/educationroot_list_users.md | 2 +- EDUGraphAPIs/Rostering/api/educationschool_list_classes.md | 2 +- EDUGraphAPIs/Rostering/api/educationschool_list_users.md | 2 +- EDUGraphAPIs/Rostering/api/educationuser_list_classes.md | 2 +- EDUGraphAPIs/Rostering/api/educationuser_list_schools.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md index a97ef812..0830fbc6 100644 --- a/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md +++ b/EDUGraphAPIs/Assignments/api/educationassignment_list_submissions.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 873 { - "value": [ + "submissions": [ { "feedback": { text: "Great work!" diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md index 45f885e2..51b8eac5 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_resources.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 1045 { - "value": [ + "resources": [ { "assignmentResourceUrl": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeT456457AdW9f/items/017NJZI25NOB5XZNLABF7646XAMDZTQQ6T", "id": "f2387c3b-ec39-4bf2-a399-d7242677f024", diff --git a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md index db42dbef..bea74b77 100644 --- a/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md +++ b/EDUGraphAPIs/Assignments/api/educationsubmission_list_submittedresources.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 1045 { - "value": [ + "submittedResources": [ { "assignmentResourceUrl": "https://graph.microsoft.com/v1.0/drives/b!8-QjN2tsv0WyGnTv7vOvnQkmGHbbeMNLqYKONmHLVnvCVmBYIGpeT456457AdW9f/items/017NJZI25NOB5XZNLABF7646XAMDZTQQ6T", "id": "f2387c3b-ec39-4bf2-a399-d7242677f024", diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md index f37368c3..73cb9975 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_members.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 593 { - "value": [ + "members": [ { "id": "13013", "displayName": "Ora Klein", diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md index 14dede13..a93f7105 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_schools.md @@ -58,7 +58,7 @@ Content-type: application/json Content-length: 892 { - "value": [ + "schools": [ { "id": "10002", "displayName": "Fabrikam High School", diff --git a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md index 2c3381f0..902fd160 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_list_teachers.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 593 { - "value": [ + "teachers": [ { "id": "14006", "displayName": "Kristie Mitchell", diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md index 2d741c18..a0ccb760 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_classes.md @@ -58,7 +58,7 @@ Content-type: application/json Content-length: 277 { - "value": [ + "classes": [ { "id": "11019", "description": "Health Level 1", diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md index 2091e4f4..2d896438 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_schools.md @@ -56,7 +56,7 @@ Content-type: application/json Content-length: 345 { - "value": [ + "schools": [ { "id": "10001", "displayName": "Contoso High School", diff --git a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md index b6b71333..17085ce7 100644 --- a/EDUGraphAPIs/Rostering/api/educationroot_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationroot_list_users.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 593 { - "value": [ + "users": [ { "id": "13012", "displayName": "Dion Matheson", diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md index 3545beef..dfd7f08b 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_classes.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 277 { - "value": [ + "classes": [ { "id": "11019", "description": "Health Level 1", diff --git a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md index 0537a931..69838250 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_list_users.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_list_users.md @@ -57,7 +57,7 @@ Content-type: application/json Content-length: 593 { - "value": [ + "users": [ { "id": "13012", "displayName": "Dion Matheson", diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md index abb75b34..c9619fa7 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_classes.md @@ -60,7 +60,7 @@ Content-type: application/json Content-length: 277 { - "value": [ + "classes": [ { "id": "11019", "description": "Health Level 1", diff --git a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md index 1229e9df..cdfe8e81 100644 --- a/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md +++ b/EDUGraphAPIs/Rostering/api/educationuser_list_schools.md @@ -60,7 +60,7 @@ Content-type: application/json Content-length: 345 { - "value": [ + "schools": [ { "id": "10001", "displayName": "Contoso High School", From 1597eeddf64b6dbb3a410aad84c39b73371308e9 Mon Sep 17 00:00:00 2001 From: John Austin Date: Mon, 20 Nov 2017 15:42:01 -0800 Subject: [PATCH 86/87] updated add, remove titles --- EDUGraphAPIs/Rostering/api/educationclass_post_members.md | 2 +- EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md index e5223331..8b08d268 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_members.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_members.md @@ -1,4 +1,4 @@ -# Add a student to a class roster +# Add a student > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. diff --git a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md index 5caa12a5..8ebc5b28 100644 --- a/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md +++ b/EDUGraphAPIs/Rostering/api/educationclass_post_teachers.md @@ -1,4 +1,4 @@ -# Add an educationUser (teacher) to an educationClass +# Add a teacher > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. From 85cecf5ce5b98e7bcb941e9a307f5830f8536f0b Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Mon, 20 Nov 2017 15:53:36 -0800 Subject: [PATCH 87/87] Fix typo in title. --- EDUGraphAPIs/Rostering/api/educationschool_update.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/EDUGraphAPIs/Rostering/api/educationschool_update.md b/EDUGraphAPIs/Rostering/api/educationschool_update.md index eed10e91..dc46943c 100644 --- a/EDUGraphAPIs/Rostering/api/educationschool_update.md +++ b/EDUGraphAPIs/Rostering/api/educationschool_update.md @@ -1,4 +1,4 @@ -# Update educationschool prpoerties +# Update educationschool properties > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported. @@ -110,4 +110,4 @@ Content-length: 292 "keywords": "", "section": "documentation", "tocPath": "" -}--> \ No newline at end of file +}-->