SIS Integration API
Includes helpers for integration with SIS systems.
Retrieve assignments enabled for grade export to SIS SisApiController#sis_assignments
BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.
GET /api/sis/accounts/:account_id/assignments
GET /api/sis/courses/:course_id/assignments
Retrieve a list of published assignments flagged as “post_to_sis”. Assignment group and section information are included for convenience.
Each section includes course information for the origin course and the cross-listed course, if applicable. The `origin_course` is the course to which the section belongs or the course from which the section was cross-listed. Generally, the `origin_course` should be preferred when performing integration work. The `xlist_course` is provided for consistency and is only present when the section has been cross-listed.
The `override` is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section.
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| account_id | integer |
The ID of the account to query. |
|
| course_id | integer |
The ID of the course to query. |
|
| starts_before | DateTime |
When searching on an account, restricts to courses that start before this date (if they have a start date) |
|
| ends_after | DateTime |
When searching on an account, restricts to courses that end after this date (if they have an end date) |
|
| include | string |
Array of additional information to include.
Allowed values: |
Example Response:
[
{
"id": 4,
"course_id": 6,
"name": "Assignment Title",
"created_at": "2014-12-01T17:00:00Z",
"due_at": "2015-01-01T17:00:00Z",
"points_possible": 100,
"integration_id": "IA-100",
"submission_types": "["online_quiz"]",
"integration_data": {
"other_data": "values"
},
"include_in_final_grade": true,
"assignment_group": {
"id": 12,
"name": "Assignments Group",
"group_weight": 0.0,
"sis_source_id": "abc123"
}
"sections": [
{
"id": 27,
"name": "Section C2-S16",
"sis_id": "C2-S16",
"integration_id": "S-16",
"origin_course": {
"id": 2,
"sis_id": "C2",
"integration_id": "I-2"
},
"xlist_course": {
"id": 6,
"sis_id": "C6",
"integration_id": "I-6"
},
"override": {
"override_title": "Assignment Title",
"due_at": "2015-02-01%17:00:00Z"
}
},
],
"user_overrides": [
{
"id": 54351,
"title": "Some Title",
"due_at": "2017-02-08 22:11:10",
"unlock_at": null,
"lock_at": null,
"students": [
{
"user_id": 643194
"sis_user_id": SIS_123
},
{
"user_id": 643195
"sis_user_id": SIS_456
}
]
}
]
},
...
]