From c8d65bdbb1b79707de159d67a437b9757378fb1e Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 1 Nov 2017 16:00:13 -0700 Subject: [PATCH 01/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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/48] 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.