Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edits and updates to the docs. #17

Open
wants to merge 98 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
c8d65bd
Edit pass in progress.
Lauragra Nov 1, 2017
be9ca11
Edits in progress.
Lauragra Nov 2, 2017
9128bc3
Finished initial edit pass on overview topic.
Lauragra Nov 2, 2017
6dbe653
Added links.
Lauragra Nov 2, 2017
2a9e691
Edit pass.
Lauragra Nov 2, 2017
eec1c06
Edit pass.
Lauragra Nov 2, 2017
d02705c
Edit.
Lauragra Nov 2, 2017
f39324b
Edit pass.
Lauragra Nov 2, 2017
938a12d
Edit pass.
Lauragra Nov 7, 2017
0e4cc29
Edit pass.
Lauragra Nov 7, 2017
e42ed6a
Edit pass.
Lauragra Nov 7, 2017
522df71
Edit pass.
Lauragra Nov 8, 2017
b5db9ac
Modifications for inheritance break in educationUser.
garethj-msft Nov 8, 2017
8212f7e
Fixed typo.
Lauragra Nov 8, 2017
bd5f37b
Fixed formatting.
Lauragra Nov 8, 2017
0fa0376
Merge pull request #1 from garethj-msft/garethj/betaRostering
Lauragra Nov 8, 2017
bec91c9
Edit pass.
Lauragra Nov 8, 2017
aeb11f3
Assignments resourceUrl is now a function and not a property
kwiggen Nov 8, 2017
131bdc1
Update topic organization.
Lauragra Nov 8, 2017
9f274d7
Edits.
Lauragra Nov 8, 2017
5ce1bd2
Edits.
Lauragra Nov 9, 2017
71f9d73
Edit.
Lauragra Nov 9, 2017
14c7565
add request body
kwiggen Nov 9, 2017
30294dc
Merge branch 'KWUpdates' of https://github.com/kwiggen/O365-EDU-Tools…
kwiggen Nov 9, 2017
62ddb45
Merge pull request #2 from kwiggen/KWUpdates
Lauragra Nov 9, 2017
d1e007f
Edit pass.
Lauragra Nov 9, 2017
69db110
Edit pass.
Lauragra Nov 9, 2017
4130ff7
Deleted note.
Lauragra Nov 9, 2017
68b9a00
Removed note.
Lauragra Nov 9, 2017
52300aa
Edit pass.
Lauragra Nov 9, 2017
0ff747f
Edits.
Lauragra Nov 9, 2017
55d6588
Edit.
Lauragra Nov 9, 2017
ca1c369
Edit pass.
Lauragra Nov 9, 2017
c1866bb
Minor updates to terminology.
Lauragra Nov 10, 2017
d822021
Added links to assignment and rostering resources and APIs.
Lauragra Nov 11, 2017
7033643
Updates.
Lauragra Nov 11, 2017
fb27d06
Edit pass.
Lauragra Nov 11, 2017
373debe
Edit.
Lauragra Nov 11, 2017
0122d0a
Add file.
Lauragra Nov 13, 2017
de891b5
Fix typo.
Lauragra Nov 13, 2017
1c76a7f
Fix order of the APIs
Lauragra Nov 13, 2017
69745ee
Test link fix.
Lauragra Nov 13, 2017
37452ac
Test link fix.
Lauragra Nov 13, 2017
6452778
test link fix.
Lauragra Nov 13, 2017
a700aee
Update links.
Lauragra Nov 13, 2017
b03f4c1
Fix link.
Lauragra Nov 13, 2017
b0af6ab
Deleted files.
Lauragra Nov 13, 2017
08148d8
Update heading.
Lauragra Nov 13, 2017
a7f64a5
Updated authorization section.
Lauragra Nov 13, 2017
10b7ee4
Made text more concise.
Lauragra Nov 13, 2017
720a5ab
Edits.
Lauragra Nov 14, 2017
fa3ff87
Added a comment.
Lauragra Nov 14, 2017
55e9393
Added boilerplate.
Lauragra Nov 14, 2017
a954428
Edit pass.
Lauragra Nov 14, 2017
6d0f745
Edit pass.
Lauragra Nov 14, 2017
0bd7d74
Edit pass.
Lauragra Nov 14, 2017
007840a
Edit pass.
Lauragra Nov 15, 2017
0fb2a3e
Edit.
Lauragra Nov 15, 2017
aef8178
Removed truncated note when there is no response body.
Lauragra Nov 15, 2017
e394e99
Removed the truncated note when there is no response body.
Lauragra Nov 15, 2017
0b9db4a
Replace angle brackets.
Lauragra Nov 15, 2017
a4ea2cc
Replace angle brackets.
Lauragra Nov 15, 2017
7515a70
first edits
JohnMAustin Nov 15, 2017
a73f2ab
Merge pull request #2 from JohnAustin-MSFT/johnau-edit
Nov 15, 2017
d3c47d7
Merge from upstream master
JohnMAustin Nov 15, 2017
ad687ec
remove merge tokens
JohnMAustin Nov 15, 2017
862dbbc
completed manual merge
JohnMAustin Nov 15, 2017
1825b95
Update title.
Lauragra Nov 16, 2017
1e9dfdb
Another fix.
Lauragra Nov 16, 2017
148a777
Edit.
Lauragra Nov 16, 2017
285b993
Edit.
Lauragra Nov 16, 2017
f0f38cd
Edit.
Lauragra Nov 16, 2017
11bdbc7
Changed member to student.
Lauragra Nov 16, 2017
4af0d70
Deleted the Important.
Lauragra Nov 16, 2017
a139495
Edit.
Lauragra Nov 16, 2017
9cd4513
Edit.
Lauragra Nov 16, 2017
78efdaf
Edits.
Lauragra Nov 16, 2017
b7d6e92
Delete comment.
Lauragra Nov 16, 2017
325ed9d
Changed Delete to Remove.
Lauragra Nov 16, 2017
81e9231
Changed Delete to Remove.
Lauragra Nov 16, 2017
121ca87
Edit.
Lauragra Nov 16, 2017
66b10f3
added json exaamples with 'real' values
JohnMAustin Nov 17, 2017
483c21d
added real examples
JohnMAustin Nov 17, 2017
e7e2d54
added sample data to json responses:
JohnMAustin Nov 17, 2017
87cd48e
Merge branch 'johnau-edit'
JohnMAustin Nov 17, 2017
b45362f
merge from upstream lauragra master
JohnMAustin Nov 17, 2017
e8335dd
merged changes from upstream
JohnMAustin Nov 17, 2017
2b67775
merged from local master
JohnMAustin Nov 17, 2017
13bdb76
fixed title of remove student from class
JohnMAustin Nov 17, 2017
7348ff1
Added beta disclaimer.
Lauragra Nov 20, 2017
2ea541b
merged from master. Completed API example blocks
JohnMAustin Nov 20, 2017
90932c6
merged from upstream master
JohnMAustin Nov 20, 2017
2a0456e
merge from origin master
JohnMAustin Nov 20, 2017
d266b49
corrected list examples
JohnMAustin Nov 20, 2017
1597eed
updated add, remove titles
JohnMAustin Nov 20, 2017
27f00de
Merge pull request #5 from JohnAustin-MSFT/johnau-edit
Lauragra Nov 20, 2017
6588e47
Merge pull request #6 from Lauragra/johnau-edit
Lauragra Nov 20, 2017
85cecf5
Fix typo in title.
Lauragra Nov 20, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"workbench.colorTheme": "Default Light+"
}
59 changes: 0 additions & 59 deletions EDUGraphAPIs/Assignments/GettingStarted.md

This file was deleted.

23 changes: 14 additions & 9 deletions EDUGraphAPIs/Assignments/api/educationassignment_delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Delete educationAssignment

Use this API to delete an existing Assignment. No request body is necessary. Only Teachers within a Class can delete Assignments.
> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

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).
Expand All @@ -13,9 +15,9 @@ One of the following permissions is required to call this API. To learn more, in

## HTTP request

```http
<!-- { "blockType": "ignored" } -->

```http
DELETE /education/classes/<id>/assignments/<id>
```
## Request headers
Expand All @@ -28,26 +30,29 @@ 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.
### Request
The following is an example of the request.

```http
<!-- {
"blockType": "request",
"name": "delete_educationassignment"
}-->

DELETE https://graph.microsoft.com/beta/education/classes/<id>/assignments/<id>
```http
DELETE https://graph.microsoft.com/beta/education/classes/11014/assignments/19002
```
##### 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.
### Response
The following is an example of the response.


<!-- {
"blockType": "response",
"truncated": true
} -->

```http
HTTP/1.1 204 No Content
```
Expand Down
63 changes: 39 additions & 24 deletions EDUGraphAPIs/Assignments/api/educationassignment_get.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# 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.
> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Get the properties and relationships of an assignment. Students can only see assignments assigned to them; teachers can see all assignments in a class.

## Permissions
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 |
Expand All @@ -20,7 +17,7 @@ is already found on the graph. When the code moves to production, this will be u
## HTTP request
<!-- { "blockType": "ignored" } -->
```http
GET /education/classes/<id>/assignments/<id>
GET /education/classes/{id}/assignments/{id}
```
## Optional query parameters
This method supports the [OData Query Parameters](http://graph.microsoft.io/docs/overview/query_parameters) to help customize the response.
Expand All @@ -34,19 +31,22 @@ This method supports the [OData Query Parameters](http://graph.microsoft.io/docs
Do not supply a request body for this method.

## Response
If successful, this method returns a `200 OK` response code and [educationAssignment](../resources/educationassignment.md) object in the response body.
If successful, this method returns a `200 OK` response code and an [educationAssignment](../resources/educationassignment.md) object in the response body.
## Example
##### Request
Here is an example of the request.
The following is an example of the request.
<!-- {
"blockType": "request",
"name": "get_educationassignment"
}-->
```http
GET https://graph.microsoft.com/beta/education/classes/<id>/assignments/<id>
GET https://graph.microsoft.com/beta/education/classes/11014/assignments/19002
```
##### 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 the properties will be returned from an actual call.

<!-- {
"blockType": "response",
"truncated": true,
Expand All @@ -58,23 +58,38 @@ Content-type: application/json
Content-length: 279

{
"id": "String (identifier)",
"id": "19002",
"allowLateSubmissions": true,
"allowStudentsToAddResourcesToSubmission": true,
"assignDateTime": "String (timestamp)",
"assignTo": {"@odata.type": "microsoft.graph.educationAssignmentRecipient"},
"assignedDateTime": "String (timestamp)",
"classId": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"displayName": "String",
"dueDateTime": "String (timestamp)",
"grading": {"@odata.type": "microsoft.graph.educationAssignmentGradeType"},
"instructions": {"@odata.type": "microsoft.graph.itemBody"},
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"resourcesFolderUrl": "String",
"status": "string"
"assignedDateTime": "2014-01-01T00:00:00Z",
"classId": "11006",
"createdBy": {
"user": {
"displayName": "Susana Rocha",
"id": "14012",
}
},
"createdDateTime": "2014-01-01T00:00:00Z",
"displayName": "Mid term exam",
"dueDateTime": "2014-01-11T00:00:00Z",
"grading": {
"@odata.type": "#microsoft.graph.educationAssignmentPointsGradeType",
"maxPoints": 100
},
"instructions": {
"content": "Answer every question correctly",
"contentType": "Text"
},
"lastModifiedBy": {
"user": {
"displayName": "Susana Rocha",
"id": "14012",
}
},
"lastModifiedDateTime": "2014-01-01T00:00:00Z",
"status": "assigned"
}
```

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# educationAssignment: getResourcesFolderUrl

> **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

This function returns the OneDrive URL where all file-based resources (Word, Excel, and so on) should be uploaded.
Note that files must be located in this folder in order to be added as resources. Only a teacher in the class can determine what files to upload.

## 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).

|Permission type | Permissions (from least to most privileged) |
|:--------------------|:---------------------------------------------------------|
|Delegated (work or school account) | EduAssignments.ReadBasic, EduAssignments.Read |
|Delegated (personal Microsoft account) | Not supported. |
|Application | Not supported. |

## HTTP request
<!-- { "blockType": "ignored" } -->
```http
POST /education/classes/{id}/assignments/{id}/getResourcesFolderUrl

```
## Request headers
| Header | Value |
|:---------------|:--------|
| 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 OneDrive URL of a folder in which 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.
<!-- {
"blockType": "request",
"name": "educationassignment_publish"
}-->
```http
POST https://graph.microsoft.com/beta/education/classes/11012/assignments/19002/getResourcesFolderUrl
```

##### Response
The following is an example of a response.

<!-- {
"blockType": "response",
"truncated": true,
"@odata.type": "microsoft.graph.educationAssignment"
} -->
```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"
}
```

<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
2015-10-25 14:57:30 UTC -->
<!-- {
"type": "#page.annotation",
"description": "educationAssignment: publish",
"keywords": "",
"section": "documentation",
"tocPath": ""
}-->
Loading