Authenticate
| API | Description |
|---|---|
| GET api/Authenticate/{id} |
Get Authenticated User Information for Q GUID. |
| GET ims/oneroster/v1p1/Authenticate/{id} |
Get Authenticated User Information for Q GUID. |
Dynamic
| API | Description |
|---|---|
| GET api/GetDynamicSP/{id} |
Return results for Stored Procedure whose key is (id), as defined in the table QWebAPIProcedure. Specify all required parameters and make sure each parameter starts with @. i.e. @trkuniq |
| POST api/PostDynamicSP/{id} |
Post data with Stored Procedure whose key is (id), as defined in the table QWebAPIProcedure. Specify all required parameters and make sure each parameter starts with @. i.e. @trkuniq XML in the request body will automatically be passed to the Stored Procedure in the parameter @flds. The Stored Procedure MUST return a recordset which will be returned to the user. |
Faculty
| API | Description |
|---|---|
| GET api/FacultyByIdent/{id} |
Get information for the Faculty member defined by their FacultyId. |
| GET api/FacultyByUnique/{id} |
Get information for the Faculty member defined by their FacultyUnique. |
| GET api/FacultyByTrack/{id} |
Get all Faculty members who have an active record in the specified Track. |
GradeBookAssignments
| API | Description |
|---|---|
| GET api/GradeBookAssignments |
Get array of Gradebook Assignments for class sections filtered by the query string parameters specified. |
| GET ims/oneroster/v1p1/GradeBookAssignments |
Get array of Gradebook Assignments for class sections filtered by the query string parameters specified. |
GradeBookAssignmentScores
| API | Description |
|---|---|
| POST api/GradeBookAssignmentScores |
Update the Gradebook Student Scores for the Assignments specified in the request body. |
| POST ims/oneroster/v1p1/GradeBookAssignmentScores |
Update the Gradebook Student Scores for the Assignments specified in the request body. |
GradeBookAssignmentStandards
| API | Description |
|---|---|
| GET api/GradeBookAssignmentStandards/{id} |
Get all Standards associated with a single assignment. |
| GET ims/oneroster/v1p1/GradeBookAssignmentStandards/{id} |
Get all Standards associated with a single assignment. |
GradeBookAssignmentStudents
| API | Description |
|---|---|
| GET api/GradeBookAssignmentStudents/{id} |
Get the array of Students responsible for an Assignment. |
| GET ims/oneroster/v1p1/GradeBookAssignmentStudents/{id} |
Get the array of Students responsible for an Assignment. |
Login
| API | Description |
|---|---|
| POST api/Login |
Authenticate User Q Login. User Ident and encrypted Password passed in the request body. |
| POST ims/oneroster/v1p1/Login |
Authenticate User Q Login. User Ident and encrypted Password passed in the request body. |
MasterSchedule
| API | Description |
|---|---|
| GET api/MasterSchedule |
Get array of Class Section information filtered by the query string parameters specified. |
| GET ims/oneroster/v1p1/MasterSchedule |
Get array of Class Section information filtered by the query string parameters specified. |
OauthToken
| API | Description |
|---|---|
| POST api/token |
Get OAUTH Token. |
| POST ims/oneroster/v1p1/token |
Get OAUTH Token. |
OneRosterAcademicSessions
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/academicSessions |
Get information for Terms. |
| GET ims/oneroster/v1p1/terms |
Get information for Terms. |
| GET ims/oneroster/v1p1/academicSessions/{id} |
Get information for a specific Terms/academicSession. |
| GET ims/oneroster/v1p1/terms/{id} |
Get information for a specific Terms/academicSession. |
| GET ims/oneroster/v1p1/gradingPeriods/{id} |
Get information for a specific Terms/academicSession. |
| GET ims/oneroster/v1p1/gradingPeriods |
Get information for Grading Periods. |
| GET ims/oneroster/v1p1/schools/{id}/terms |
Get information for all Terms in a school. |
OneRosterClass
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/classes |
Get information for all Classes active today. |
| GET ims/oneroster/v1p1/classes/{id} |
Get information for the Class defined by the mstuniq. |
| GET ims/oneroster/v1p1/schools/{id}/classes |
Get information for all Classes for a specific school. |
| GET ims/oneroster/v1p1/teachers/{id}/classes |
Get information for all Classes for a specific Teacher. |
OneRosterCourse
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/courses |
Get information for all Courses active today. |
| GET ims/oneroster/v1p1/courses/{id} |
Get information for the Course defined by the trkcrsuniq. |
| GET ims/oneroster/v1p1/schools/{id}/courses |
Get information for all Courses for a specific school. |
OneRosterDemographic
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/demographics |
Get demographics for all students active today. |
| GET ims/oneroster/v1p1/demographics/{id} |
Get demographics for the Student specified. |
OneRosterEnrollment
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/enrollments |
Get information for all Enrollments active today. |
| GET ims/oneroster/v1p1/schools/{id}/classes/{class_id}/enrollments |
Get enrollments for the Class specified. |
| GET ims/oneroster/v1p1/schools/{id}/enrollments |
Get information for all Enrollments in a specific school. |
OneRosterLineItem
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/lineItems |
Get ALL lineitems. |
| GET ims/oneroster/v1p1/lineItems/{id} |
Get the Assignment specified by the parameter. |
| GET ims/oneroster/v1p1/classes/{id}/lineItems |
Get lineitems for the Class specified. |
| POST ims/oneroster/v1p1/lineItems |
Create the Gradebook Assignment specified in the request body. |
| PUT ims/oneroster/v1p1/lineItems |
Update the Gradebook Assignment specified in the request body. |
| PUT ims/oneroster/v1p1/lineItems/{id} |
Update the Gradebook Assignment specified in the request body. |
OneRosterLineItemCategories
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/categories/{id} |
Get information for the Categories for a GradeBook Section defined by mstuniq. |
| GET ims/oneroster/v1p1/categories |
Get information for all Categories for a GradeBook defined by mstuniq. |
OneRosterOrgs
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/orgs |
Get information for the Org (school) defined by the schuniq. |
| GET ims/oneroster/v1p1/schools |
Get information for the Org (school) defined by the schuniq. |
| GET ims/oneroster/v1p1/schools/{id} |
Get information for the Org (school) defined by the schuniq. |
| GET ims/oneroster/v1p1/orgs/{id} |
Get information for the Org (school) defined by the schuniq. |
OneRosterResults
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/results |
Get ALL results. |
| GET ims/oneroster/v1p1/results/{id} |
Get the score result specified by the parameter. |
| GET ims/oneroster/v1p1/classes/{id}/results |
Get the score results for the Class specified. |
| GET ims/oneroster/v1p1/classes/{id}/lineItems/{itemid}/results |
Get the score results for the Assignment in the Class specified. |
| GET ims/oneroster/v1p1/classes/{id}/students/{ssuniq}/results |
Get the score results for the Assignment in the Class specified. |
| PUT ims/oneroster/v1p1/results |
Update the Gradebook Student Scores for the Assignments specified in the request body. |
| PUT ims/oneroster/v1p1/results/{id} |
Update the Gradebook Student Scores for the Assignments specified in the request body. |
OneRosterUsers
| API | Description |
|---|---|
| GET ims/oneroster/v1p1/users |
Get information for Users. |
| GET ims/oneroster/v1p1/users/{id} |
Get information for Students. |
| GET ims/oneroster/v1p1/students |
Get information for Students. |
| GET ims/oneroster/v1p1/students/{id} |
Get information for Students. |
| GET ims/oneroster/v1p1/schools/{id}/students |
Get information for Students in a school. |
| GET ims/oneroster/v1p1/classes/{id}/students |
Get information for Students in a class. |
| GET ims/oneroster/v1p1/teachers |
Get information for the Teachers. |
| GET ims/oneroster/v1p1/teachers/{id} |
Get information for the Teachers. |
| GET ims/oneroster/v1p1/schools/{id}/teachers |
Get information for the Teachers at a specific school. |
| GET ims/oneroster/v1p1/classes/{id}/teachers |
Get information for the Teachers for a specific class. |
School
| API | Description |
|---|---|
| GET api/School |
Get array of School information for all schools in the district. |
| GET api/School/{id} |
Get School information for the school code parameter. |
| GET ims/oneroster/v1p1/School |
Get array of School information for all schools in the district. |
| GET ims/oneroster/v1p1/School/{id} |
Get School information for the school code parameter. |
Track
| API | Description |
|---|---|
| GET api/TracksByFaculty/{id} |
Get all Active Tracks for a Faculty Unique. Filter by optional date parameter. Defaults to today. |
| GET api/TracksBySchoolYear/{id} |
Get all defined Tracks for School Year. |