Below is a list of API Endpoints and Descriptions, with the Resource and Action associated to each, sorted alphabetically by Endpoint.
Endpoint (Description) | Resource | Action |
DELETE /ims/oneroster/v1p1/categories/{id} (Delete a category) |
OneRoster: Categories | Delete |
DELETE /ims/oneroster/v1p1/lineItems/{id} (Delete a Line Item) |
OneRoster: Line Items | Delete |
DELETE /ims/oneroster/v1p1/results/{id} (Delete a result) |
OneRoster: Results | Delete |
DELETE /v1/assignmentMarks/{id} (Deletes an assignment mark) |
Assignment Marks | Delete |
DELETE /v1/assignments/{id} (Deletes an assignment) |
Assignments | Delete |
DELETE /v1/assignmentStandardMarks/{id} (Deletes an assignment standard mark) |
Assignment Standard Marks | Delete |
DELETE /v1/assignmentStandards/{id} (Deletes an assignment standard) |
Assignment Standards | Delete |
DELETE /v1/categories/{id} (Deletes an assignment category) |
Assignment Categories | Delete |
DELETE /v1/categoryaverages/{id} (Deletes a category average) |
Category Averages | Delete |
DELETE /v1/dailyAttendance/{id} (Deletes a student's daily attendance) |
Daily Attendance | Delete |
DELETE /v1/disciplineActions/{id} (Deletes a discipline action) |
Discipline Actions | Delete |
DELETE /v1/district/documenttypes/{id} (Deletes the specified document type) |
Document Upload Types | Delete |
DELETE /v1/finalExamMarks/{id} (Deletes a student's final exam mark) |
Final Exam Marks | Delete |
DELETE /v1/localDisciplineIncidents/{id} (Deletes a local discipline incident) |
Local Discipline Incidents | Delete |
DELETE /v1/localDisciplineIncidents/localStudentOffender/{id} (Deletes a local discipline incident student offender) |
Local discipline incident offenders | Delete |
DELETE /v1/markingPeriodMarks/{id} (Deletes a student's marking period mark) |
Marking Period Marks | Delete |
DELETE /v1/markingPeriodMarks/{id}/{commentid} (Deletes a selected comment) |
Marking Period Marks | Delete |
DELETE /v1/midtermExamMarks/{id} (Deletes a student's midterm exam mark) |
Midterm Exam Marks | Delete |
DELETE /v1/periodAttendance/{id} (Deletes a student's period attendance) |
Period Attendance | Delete |
DELETE /v1/periodAttendance/bulk | ||
DELETE /v1/progressPeriodMarks/{id} (Deletes a student's progress period mark) |
Progress Period Marks | Delete |
DELETE /v1/sectionMarks/{id} (Deletes a student's section mark) |
Class Section Marks | Delete |
DELETE /v1/stateDisciplineIncidents/{id} (Deletes a local discipline incident) |
State Discipline Incidents | Delete |
DELETE /v1/stateDisciplineIncidents/stateStudentOffender/{id} (Deletes a state discipline incident student offender) |
State discipline incident offenders | Delete |
DELETE /v1/studentAllergies/{id} (Deletes student allergy) |
Student Allergy | Delete |
DELETE /v1/studentAssessments/{id} (Deletes a student's assessment mark) |
Student Assessments | Delete |
DELETE /v1/students/studentdocuments/{id} (Deletes the specified student document) |
Student Uploads | Delete |
DELETE /v1/studentMedicalConditions/{id} (Deletes student medical condition) |
Student Medical Condition | Delete |
DELETE /v1/studentRestrictions/{id} (Deletes student restriction) |
Student Restriction | Delete |
DELETE /v1/transportation/BusAssignments/{id} (Delete a student bus assignment) |
Bus Assignments | Delete |
DELETE /v1/transportation/BusRoutes/{id} (Delete a bus route) |
Bus Routes | Delete |
DELETE /v1/transportation/BusRouteType/{id} (Delete a Bus Route / Bus Type Association) |
Bus Route Types | Delete |
DELETE /v1/transportation/BusStop/{id} (Delete a Bus Stop) |
Bus Stops | Delete |
GET /ims/oneroster/v1p1/academicSessions (Retrieve a list of academic sessions) |
OneRoster: AcademicSessions | Read |
GET /ims/oneroster/v1p1/academicSessions/{id} (Retrieves a specific academic session by ID) |
OneRoster: AcademicSessions | Read |
GET /ims/oneroster/v1p1/categories (Retrieve a list of categories) |
OneRoster: Categories | Read |
GET /ims/oneroster/v1p1/categories/{id} (Retrieves a specific category by ID) |
OneRoster: Categories | Read |
GET /ims/oneroster/v1p1/classes Retrieve a list of classes |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/classes/{classId}/lineItems (Return the collection of line items (Columns) in the gradebook for this class) |
OneRoster: Line Items | Read |
GET /ims/oneroster/v1p1/classes/{classId}/lineItems/{lineItemId}/results (Return the collection of results (assessed grades), for this specific lineItem (Column) for this class) |
OneRoster: Results | Read |
GET /ims/oneroster/v1p1/classes/{classId}/results (Return the collection of results (assessed grades) for this class) |
OneRoster: Results | Read |
GET /ims/oneroster/v1p1/classes/{classId}/students (Return the collection of students that are taking this class) |
OneRoster: Students | Read |
GET /ims/oneroster/v1p1/classes/{classId}/students/{studentId}/results (Return the collection of results (assessed grades), for this specific student, attending this class) |
OneRoster: Results | Read |
GET /ims/oneroster/v1p1/classes/{classId}/teachers (Return the collection of teachers that are teaching this class) |
OneRoster: Teachers | Read |
GET /ims/oneroster/v1p1/classes/{id} (Retrieves a specific class by ID) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/courses (Retrieve a list of courses) |
OneRoster: Courses | Read |
GET /ims/oneroster/v1p1/courses/{courseId}/classes (Return the collection of classes that are teaching this course) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/courses/{id} (Retrieves a specific course by ID) |
OneRoster: Courses | Read |
GET /ims/oneroster/v1p1/demographics (Retrieve a list of demographics) |
OneRoster: Demographics | Read |
GET /ims/oneroster/v1p1/demographics/{id} (Retrieves a specific demographic by ID) |
OneRoster: Demographics | Read |
GET /ims/oneroster/v1p1/enrollments (Retrieve a list of enrollments) |
OneRoster: Enrollments | Read |
GET /ims/oneroster/v1p1/enrollments/{id} (Retrieves a specific enrollment by ID) |
OneRoster: Enrollments | Read |
GET /ims/oneroster/v1p1/gradingPeriods (Retrieve a list of grading periods) |
OneRoster: GradingPeriods | Read |
GET /ims/oneroster/v1p1/gradingPeriods/{id} (Retrieves a specific grading period by ID) |
OneRoster: GradingPeriods | Read |
GET /ims/oneroster/v1p1/lineItems (Retrieve a list of line items) |
OneRoster: Line Items | Read |
GET /ims/oneroster/v1p1/lineItems/{id} (Retrieves a specific line item by ID) |
OneRoster: Line Items | Read |
GET /ims/oneroster/v1p1/orgs (Retrieve a list of orgs) |
OneRoster: Orgs | Read |
GET /ims/oneroster/v1p1/orgs/{id} (Retrieves a specific org by ID) |
OneRoster: Orgs | Read |
GET /ims/oneroster/v1p1/results (Retrieve a list of results) |
OneRoster: Results | Read |
GET /ims/oneroster/v1p1/results/{id} (Retrieves a specific result by ID) |
OneRoster: Results | Read |
GET /ims/oneroster/v1p1/schools (Retrieve a list of schools) |
OneRoster: Schools | Read |
GET /ims/oneroster/v1p1/schools/{id} (Retrieves a specific school by ID) |
OneRoster: Schools | Read |
GET /ims/oneroster/v1p1/schools/{id}/classes (Return the collection of classes taught by this school) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/schools/{id}/classes/{classId}/enrollments (Return the collection of enrollments for the specified class for this school.) |
OneRoster: Enrollments | Read |
GET /ims/oneroster/v1p1/schools/{id}/classes/{classId}/students (Return the collection of students taking this class in this school) |
OneRoster: Students | Read |
GET /ims/oneroster/v1p1/schools/{id}/classes/{classId}/teachers (Return the collection of teachers teaching this class in this school) |
OneRoster: Teachers | Read |
GET /ims/oneroster/v1p1/schools/{id}/courses (Return the collection of courses taught by this school.) |
OneRoster: Courses | Read |
GET /ims/oneroster/v1p1/schools/{id}/enrollments (Return the collection of enrollments for the specified school) |
OneRoster: Enrollments | Read |
GET /ims/oneroster/v1p1/schools/{id}/students (Return the collection of students attending this school) |
OneRoster: Students | Read |
GET /ims/oneroster/v1p1/schools/{id}/teachers (Return the collection of teachers teaching at this school) |
OneRoster: Teachers | Read |
GET /ims/oneroster/v1p1/schools/{id}/terms (Return the collection of terms that are used by this school) |
OneRoster: Terms | Read |
GET /ims/oneroster/v1p1/students (Retrieve a list of students) |
OneRoster: Students | Read |
GET /ims/oneroster/v1p1/students/{id} (Retrieves a specific student by ID) |
OneRoster: Students | Read |
GET /ims/oneroster/v1p1/students/{studentId}/classes (Return the collection of classes that this student is taking) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/teachers (Retrieve a list of teachers) |
OneRoster: Teachers | Read |
GET /ims/oneroster/v1p1/teachers/{id} (Retrieves a specific teacher by ID) |
OneRoster: Teachers | Read |
GET /ims/oneroster/v1p1/teachers/{teacherId}/classes (Return the collection of classes that this teacher is teaching) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/terms (Retrieve a list of terms) |
OneRoster: Terms | Read |
GET /ims/oneroster/v1p1/terms/{id} (Retrieves a specific term by ID) |
OneRoster: Terms | Read |
GET /ims/oneroster/v1p1/terms/{termId}/classes (Return the collection of classes that are taught in this term) |
OneRoster: Classes | Read |
GET /ims/oneroster/v1p1/terms/{termId}/gradingPeriods (Return the collection of Grading Periods that are part of this term) |
OneRoster: GradingPeriods | Read |
GET /ims/oneroster/v1p1/users (Retrieve a list of users) |
OneRoster: Users | Read |
GET /ims/oneroster/v1p1/users/{id} (Retrieves a specific user by ID) |
OneRoster: Users | Read |
GET /ims/oneroster/v1p1/users/{userId}/classes (Retrieve a list of classes) |
OneRoster: Classes | Read |
GET /v1/accommodations (Retrieves a list of accommodations) |
Accommodations | Read |
GET /v1/accommodations/{id} (Retrieves a specific accommodation by ID) |
Accommodations | Read |
GET /v1/addresses (Retrieves a list of addresses) |
Addresses | Read |
GET /v1/addresses (Retrieves a list of addresses) |
Addresses | Read |
GET /v1/addresses/{id} (Retrieves an specific address by ID) |
Addresses | Read |
GET /v1/advisors (Retrieves a list of advisors) |
Advisors | Read |
GET /v1/advisors/{id} (Retrieves a specific advisor by ID) |
Advisors | Read |
GET /v1/advisors/{id}/students (Retrieves a list of all students by advisor ID) |
Students | Read |
GET /v1/allergies (Retrieves a list of allergies) |
Allergies | Read |
GET /v1/allergies/{id} (Retrieves a specific allergy by ID) |
Allergies | Read |
GET /v1/allergyTypes (Retrieves a list of allergy types) |
Allergy Types | Read |
GET /v1/allergyTypes/{id} (Retrieves a specific allergy type by ID) |
Allergy Types | Read |
GET /v1/assessments (Retrieves a list of assessments) |
Assessments | Read |
GET /v1/assessments/{id} (Retrieves a specific assessment by ID) |
Assessments | Read |
GET /v1/assessments/assessmentTestTypes (Retrieves a list of assessment test types) |
Assessment Test Types | Read |
GET /v1/assessments/assessmentTestTypes/{id} (Retrieves a specific assessment test type by ID) |
Assessment Test Types | Read |
GET /v1/assessments/assessmentTypes (Retrieves a list of assessment types) |
Assessment Types | Read |
GET /v1/assessments/assessmentTypes/{id} (Retrieves a specific assessment type by ID) |
Assessment Types | Read |
GET /v1/assignmentMarks (Retrieves a list of assignment marks) |
Assignment Marks | Read |
GET /v1/assignmentMarks/{id} (Retrieves a specific assignment mark by ID) |
Assignment Marks | Read |
GET /v1/assignments (Retrieves a list of assignments) |
Assignments | Read |
GET /v1/assignments/{id} (Retrieves a specific assignment by ID) |
Assignments | Read |
GET /v1/assignments/{id}/assignmentMarks (Retrieves an assignment mark by assignment ID) |
Assignment Marks | Read |
GET /v1/assignments/{id}/assignmentStandards (Retrieves a list of assignment standards by assignment ID) |
Assignment Standards | Read |
GET /v1/assignmentStandardMarks (Retrieves a list of assignment standard marks) |
Assignment Standard Marks | Read |
GET /v1/assignmentStandardMarks/{id} (Retrieves a specific assignment standard mark by ID) |
Assignment Standard Marks | Read |
GET /v1/assignmentStandards (Retrieves a list of assignment standards) |
Assignment Standards | Read |
GET /v1/assignmentStandards/{id} (Retrieves a specific assignment standard by ID) |
Assignment Standards | Read |
GET /v1/attendanceReasons (Retrieves a list of attendance reasons) |
Attendance Reasons | Read |
GET /v1/attendanceReasons/{id} (Retrieves a specific attendance reason by ID) |
Attendance Reasons | Read |
GET /v1/authorities (Retrieves a list of discipline authorities( |
Discipline Authority | Read |
GET /v1/authorities/{id} (Retrieves a specific discipline authority by ID) |
Discipline Authority | Read |
GET /v1/authorityTypes (Retrieves a list of discipline authority type) |
Discipline Authority Type | Read |
GET /v1/authorityTypes/{id} (Retrieves a specific discipline authority type by ID) |
Discipline Authority Type | Read |
GET /v1/bellScheduleDay (Retrieves a list of bell schedule day) |
Bell Schedule Day | Read |
GET /v1/bellScheduleDay/{id} (Retrieves a specific bell schedule by ID) |
Bell Schedule Day | Read |
GET /v1/bellTime (Retrieves a list of bell time) |
Bell Time | Read |
GET /v1/bellTime/{id} (Retrieves a specific bell time by ID) |
Bell Time | Read |
GET /v1/bellTimePeriods (Retrieves a list of bell time periods) |
Bell Time Periods | Read |
GET /v1/bellTimePeriods/{id} (Retrieves a specific bell time period by ID) |
Bell Time Periods | Read |
GET /v1/calendarEvents (Retrieves a list of calendar events) |
Calendar Events | Read |
GET /v1/calendarEvents/{id} (Retrieves a specific calendar event by ID) |
Calendar Events | Read |
GET /v1/categories (Retrieves a list of assignment categories) |
Assignment Categories | Read |
GET /v1/categories/{id} (Retrieves an assignment category by ID) |
Assignment Categories | Read |
GET /v1/categories/{id}/assignments (Retrieves a list of all of the category's assignments) |
Assignments | Read |
GET /v1/categoryaverages (Retrieves a list of category averages) |
Category Averages | Read |
GET /v1/categoryaverages/{id} (Retrieves a category average by ID) |
Category Averages | Read |
GET /v1/cities (Retrieves a list of cities) |
Cities | Read |
GET /v1/cities/{id} (Retrieves a specific city by ID) |
Cities | Read |
GET /v1/classAttendanceIndicator (Retrieves a list of class attendance indicators) |
Class Attendance Indicators | Read |
GET /v1/comments Retrieves a list of comments |
Comments | Read |
GET /v1/comments/{id} Retrieves a specific comment by ID |
Comments | Read |
GET /v1/conditionTypes Retrieves a list of medical condition types |
Medical Condition Types | Read |
GET /v1/conditionTypes/{id} Retrieves a specific medical condition type by ID |
Medical Condition Types | Read |
GET /v1/contacts (Retrieves a list of students' contacts) |
Contacts | Read |
GET /v1/contacts/{id} (Retrieves a specific contact by ID) |
Contacts | Read |
GET /v1/contacts/studentcontacts (Retrieves a list of all of the student's contacts) |
Contacts | Read |
GET /v1/contacts/studentcontacts/{id} (Retrieves a student contact) |
Contacts | Read |
GET /v1/contactusers (Retrieves a list of user ids for student contacts) |
Contact Users | Read |
GET /v1/contactusers/{contactid} (Retrieves a specific user id by Contact ID) |
Contact Users | Read |
GET /v1/counselors (Retrieves a list of counselors) |
Counselors | Read |
GET /v1/counselors/{id} (Retrieves a specific counselor by ID) |
Counselors | Read |
GET /v1/counselors/{id}/students (Retrieves a list of all of the students by counselor ID) |
Counselors | Read |
GET /v1/countries (Retrieves a list of countries) |
Countries | Read |
GET /v1/countries/{id} (Retrieves a specific country by ID) |
Countries | Read |
GET /v1/courseAssessments (Retrieves a list of course assessments) |
Course Assessments | Read |
GET /v1/courseAssessments/{id} (Retrieves a specific course assessment by ID) |
Course Assessments | Read |
GET /v1/courseAssessments/courseAssessmentTypes (Retrieves a list of assessment types) |
Course Assessment Types | Read |
GET /v1/courseAssessments/courseAssessmentTypes/{id} (Retrieves a specific course assessment type by ID) |
Course Assessment Types | Read |
GET /v1/courses (Retrieves a list of courses) |
School Courses | Read |
GET /v1/courses/{id} (Retrieves a specific course by ID) |
School Courses | Read |
GET /v1/courses/{id}/sections (Retrieves a list of all the course's sections) |
Class Sections | Read |
GET /v1/credits (Retrieves a list of course credits) |
Course Credits | Read |
GET /v1/credits/{id} (Retrieves a specific course credit by ID) |
Course Credits | Read |
GET /v1/dailyAttendance (Retrieves a list of students' daily attendances) |
Daily Attendance | Read |
GET /v1dailyAttendance/totals (Retrieves a list of students’ daily attendance totals) |
Daily Attendance | Read |
GET /v1/dailyAttendance/{id} (Retrieves a specific student's daily attendance by ID) |
Daily Attendance | Read |
GET /v1/departments (Retrieves a list of departments) |
Departments | Read |
GET /v1/departments/{id} (Retrieves a specific department by ID) |
Departments | Read |
GET /v1/disciplineActions (Retrieves a list of state discipline actions) |
Discipline Actions | Read |
GET /v1/disciplineActions/{id} (Retrieves a specific discipline action by ID) |
Discipline Actions | Read |
GET /v1/disciplineActionTypes (Retrieves a list of discipline action types) |
Discipline Action Types | Read |
GET /v1/disciplineActionTypes/{id} (Retrieves a specific discipline action type by ID) |
Discipline Action Types | Read |
GET /v1/district/documenttypes (Retrieves a list of document types) |
Document Upload Types | Read |
GET /v1/district/documenttypes/{id} (Retrieves a document type by id) |
Document Upload Types | Read |
GET /v1/district/documenttypes/categories (Retrieves a list of document categories) |
Document Upload Types | Read |
GET /v1/finalExamMarks (Retrieves a list of students' final exam marks) |
Final Exam Marks | Read |
GET /v1/finalExamMarks/{id} (Retrieves a specific student's final mark by ID) |
Final Exam Marks | Read |
GET /v1/gradeLevels (Retrieves a list of grade levels) |
Grade Levels | Read |
GET /v1/gradeLevels/{id} (Retrieves a specific grade level by ID) |
Grade Levels | Read |
GET /v1/household (Retrieves a list of household) |
Households | Read |
GET /v1/household/{id} (Retrieves a specific household by ID) |
Households | Read |
GET /v1/household/{id}/contacts (Retrieves a list of contacts by household) |
Contacts | Read |
GET /v1/household/{id}/students (Retrieves a list of students by household) |
Students | Read |
GET /v1/incidentTypes (Retrieves a list of discipline incident types) |
Discipline Incident Types | Read |
GET /v1/incidentTypes/{id} (Retrieves a specific discipline incident type by ID) |
Discipline Incident Types | Read |
GET /v1/localDisciplineIncidents (Retrieves a list of local discipline incidents) |
Local Discipline Incidents | Read |
GET /v1/localDisciplineIncidents/{id} (Retrieves a specific local discipline incident by ID) |
Local Discipline Incidents | Read |
GET /v1/localDisciplineIncidents/{id}/localStudentOffenders (Retrieves a list of state discipline incident offenders) |
State discipline incident offenders | Read |
GET /v1/markingPeriodMarks (Retrieves a list of students' marking period marks) |
Marking Period Marks | Read |
GET /v1/markingPeriodMarks/{id} (Retrieves a specific marking period mark by ID) |
Marking Period Marks | Read |
GET /v1/markingPeriods (Retrieves a list of marking periods) |
Marking Period Terms | Read |
GET /v1/markingPeriods/{id} (Retrieves a specific marking period by ID) |
Marking Period Terms | Read |
GET /v1/marks (Retrieves a list of marks) |
Marks | Read |
GET /v1/marks/{id} (Retrieves a specific mark by ID) |
Marks | Read |
GET /v1/medications (Retrieves a list of medications) |
Medications | Read |
GET /v1/medications/{id} (Retrieves a specific medication by ID) |
Medications | Read |
GET /v1/medicationTypes (Retrieves a list of medication types) |
Medications | Read |
GET /v1/medicationTypes/{id} (Retrieves a specific medication type by ID) |
Medications | Read |
GET /v1/midtermExamMarks (Retrieves a list of students' midterm exam marks) |
Midterm Exam Marks | Read |
GET /v1/midtermExamMarks/{id} (Retrieves a specific midterm exam mark by section enrollment ID) |
Midterm Exam Marks | Read |
GET /v1/periodAttendance (Retrieves a list of students' period attendance) |
Period Attendance | Read |
GET /v1/periodAttendance/{id} (Retrieves a specific period attendance by ID) |
Period Attendance | Read |
GET /v1/periods (Retrieves a list of periods) |
Periods | Read |
GET /v1/periods/{id} (Retrieves a specific period by ID) |
Periods | Read |
GET /v1/persons (Retrieves a list of persons) |
Persons | Read |
GET /v1/persons/{id} (Retrieves a specific person by ID) |
Persons | Read |
GET /v1/personTypes (Retrieves a list of person types) |
Person Types | Read |
GET /v1/personTypes/{id} (Retrieves a specific person by ID) |
Person Types | Read |
GET /v1/progressPeriodMarks (Retrieves a list of students' progress period marks) |
Progress Period Marks | Read |
GET /v1/progressPeriodMarks/{id} (Retrieves a specific progress period mark by ID) |
Progress Period Marks | Read |
GET /v1/progressPeriods (Retrieves a list of progress periods) |
Progress Period Terms | Read |
GET /v1/progressPeriods/{id} (Retrieves a specific progress report by ID) |
Progress Period Terms | Read |
GET /v1/restrictionTypes (Retrieves a list of restriction types) |
Restriction Types | Read |
GET /v1/restrictionTypes/{id} (Retrieves a specific restriction type by ID) |
Restriction Types | Read |
GET /v1/rooms (Retrieves a list of rooms) |
Room | Read |
GET /v1/rooms/{id} (Retrieves a specific room by ID) |
Room | Read |
GET /v1/schools (Retrieves a list of schools) |
Schools | Read |
GET /v1/schools/{id} (Retrieves a specific school by ID) |
Schools | Read |
GET /v1/schools/{id}/advisors (Retrieves a list of all of the school's advisors by school ID) |
Advisors | Read |
GET /v1/schools/{id}/bellScheduleDay (Retrieves a list of all of the school's bell schedule days by school ID) |
Bell Schedule Day | Read |
GET /v1/schools/{id}/calendarEvents (Retrieves a list of all of the calendar events by school ID) |
Calendar Events | Read |
GET /v1/schools/{id}/contacts (Retrieves a list of all of the school's contacts by school ID) |
Contacts | Read |
GET /v1/schools/{id}/counselors (Retrieves a list of all of the school's counselors by school ID) |
Counselors | Read |
GET /v1/schools/{id}/courses (Retrieves a list of all of the courses by school ID) |
School Courses | Read |
GET /v1/schools/{id}/credits (Retrieves a list of all of the school's credits by school ID) |
Course Credits | Read |
GET /v1/schools/{id}/dailyAttendance (Retrieves a list of all of the school's daily attendance by school ID) |
Daily Attendance | Read |
GET /v1/schools/{id}/gradeLevels (Retrieves a list of all of the grade levels by school ID) |
Grade Levels | Read |
GET /v1/schools/{id}/markingPeriods (Retrieves a list of all of the school's marking periods by school ID) |
Marking Period Terms | Read |
GET /v1/schools/{id}/periodAttendance (Retrieves a list of all of the school's period attendance by school ID) |
Period Attendance | Read |
GET /v1/schools/{id}/progressPeriods (Retrieves a list of all of the school's progress periods by school ID) |
Progress Period Terms | Read |
GET /v1/schools/{id}/rooms (Retrieves a list of all of the school's rooms by school ID) |
Room | Read |
GET /v1/schools/{id}/sections (Retrieves a list of all of the school's sections by school ID) |
Class Sections | Read |
GET /v1/schools/{id}/semesters (Retrieves a list of all of the schools semesters by school ID) |
Semester Terms | Read |
GET /v1/schools/{id}/staff (Retrieves a list of all of the staff by school ID) |
Staff | Read |
GET /v1/schools/{id}/staffUsers (Retrieves a list of all of the users by school ID) |
Users | Read |
GET /v1/schools/{id}/students (Retrieves a list of all of the school's students by school ID) |
Students | Read |
GET /v1/schools/{id}/teachers (Retrieves a list of all of the school's teachers by school ID) |
Teachers | Read |
GET /v1/schools/{type} (Retrieves a specific school by school type) |
Schools | Read |
GET /v1/schools/getDistrictAndSchools (Retrieve a list of schools with district) |
Schools | Read |
GET /v1/schoolYears (Retrieves a list of school years) |
School Year Terms | Read |
GET /v1/schoolYears/{id} (Retrieves a specific school year by ID) |
School Year Terms | Read |
GET /v1/schoolYears/{id}/calendarEvents (Retrieves a list of all of the calendar events by scheduling year ID) |
Calendar Events | Read |
GET /v1/schoolYears/Current (Retrieves the current school year for the district) |
School Year Terms | Read |
GET /v1/scoringMethod (Retrieves a list of student's scoring method) |
Scoring Methods | Read |
GET /v1/scoringMethod/{id} (Retrieves a specific scoring method by ID) |
Scoring Methods | Read |
GET /v1/sectionEnrollments (Retrieves a list of students' section enrollments) |
Section Enrollments | Read |
GET /v1/sectionEnrollments/{id} (Retrieves a specific section enrollment by ID) |
Section Enrollments | Read |
GET /v1/sectionEnrollments/{id}/assignmentMarks (Retrieves all of student's assignment marks by section enrollment ID) |
Assignment Marks | Read |
GET /v1/sectionEnrollments/{id}/finalExamMark (Retrieves a specific student's final mark by ID) |
Final Exam Marks | Read |
GET /v1/sectionEnrollments/{id}/markingPeriodMarks (Retrieves all of student's marking period marks by section enrollment ID) |
Marking Period Marks | Read |
GET /v1/sectionEnrollments/{id}/midtermMark (Retrieves a specific midterm exam mark by section enrollment ID) |
Midterm Exam Marks | Read |
GET /v1/sectionEnrollments/{id}/progressPeriodMarks (Retrieves all of student's progress report marks by section enrollment ID) |
Progress Period Marks | Read |
GET /v1/sectionEnrollments/{id}/sectionMark (Retrieves a specific section mark by ID) |
Class Section Marks | Read |
GET /v1/sectionMarks (Retrieves a list of students' section marks) |
Class Section Marks | Read |
GET /v1/sectionMarks/{id} (Retrieves a specific section mark by ID) |
Class Section Marks | Read |
GET /v1/sections (Retrieves a list of class sections) |
Class Sections | Read |
GET /v1/sections/{id} (Retrieves a specific class section by ID) |
Class Sections | Read |
GET /v1/sections/{id}/assignmentMarks (Retrieves a list of the class section's assignment marks) |
Assignment Marks | Read |
GET /v1/sections/{id}/assignments (Retrieves a list of the class section's assignments) |
Assignments | Read |
GET /v1/sections/{id}/categories (Retrieves a list of the section's assignment categories) |
Assignment Categories | Read |
GET /v1/sections/{id}/finalExamMarks (Retrieves a list of all the class section's final exam marks) |
Final Exam Marks | Read |
GET /v1/sections/{id}/markingPeriodMarks (Retrieves a list of all the class section's marking period marks) |
Marking Period Marks | Read |
GET /v1/sections/{id}/markingPeriods (Retrieves a list of all of the class section's marking periods) |
Marking Period Terms | Read |
GET /v1/sections/{id}/meetingtimes (Retrieves a list of all of the section's meeting times by section ID) |
Class Sections | Read |
GET /v1/sections/{id}/midtermExamMarks (Retrieves a list of all the class section's midterm exam marks) |
Midterm Exam Marks | Read |
GET /v1/sections/{id}/progressPeriodMarks (Retrieves a list of progress report grades by section ID) |
Progress Period Marks | Read |
GET /v1/sections/{id}/progressPeriods (Retrieves a list of all the class section's progress periods) |
Progress Period Terms | Read |
GET /v1/sections/{id}/sectionMarks (Retrieves a list of all the class section's section marks) |
Class Section Marks | Read |
GET /v1/sections/{id}/students (Retrieves all of the students enrolled in this section) |
Students | Read |
GET /v1/sections/{id}/teachers (Retrieves a list of all of the section's teachers by section ID) |
Teachers | Read |
GET /v1/sections/GetSectionSysIdFromCode (Retrieves a system sectionID by Section Code) |
Class Sections | Read |
GET /v1/semesters (Retrieves a list of semesters) |
Semester Terms | Read |
GET /v1/semesters/{id} (Retrieves a specific semester by ID) |
Semester Terms | Read |
GET /v1/staff (Retrieves a list of staff members) |
Staff | Read |
GET /v1/staff/{id} (Retrieves a specific staff member by ID) |
Staff | Read |
GET /v1/staffUsers (Retrieves a list of users) |
Users | Read |
GET /v1/staffUsers/{userId} (Retrieves a specific user by user ID) |
Users | Read |
GET /v1/standards (Retrieves a list of the district standards) |
Standards | Read |
GET /v1/standards/{id} (Retrieves a specific standard by ID) |
Standards | Read |
GET /v1/standardMarkingPeriodMarks (Retrieves a list of students’ standard marking period marks) |
Marking Period Marks | Read |
GET /v1/standardProgressPeriodMarks (Retrieves a list of students’ standard progress report marks) |
Progress Period Marks | Read |
GET /v1/stateDisciplineIncidents (Retrieves a list of state discipline incidents) |
State Discipline Incidents | Read |
GET /v1/stateDisciplineIncidents/{id} (Retrieves a specific state discipline incident by ID) |
State Discipline Incidents | Read |
GET /v1/stateDisciplineIncidents/{id}/stateStudentOffenders (Retrieves a list of state discipline incident offenders) |
State discipline incident offenders | Read |
GET /v1/states (Retrieves a list of states) |
States | Read |
GET /v1/states/{id} (Retrieves a specific state by ID) |
States | Read |
GET /v1/streets (Retrieves a list of streets) |
Streets | Read |
GET /v1/streets/{id} (Retrieves a specific street by ID) |
Streets | Read |
GET /v1/studentAllergies (Retrieves a list of student allergies) |
Student Allergies | Read |
GET /v1/studentAllergies/{id} (Retrieves a specific student allergy by ID) |
Student Allergies | Read |
GET /v1/studentAssessments (Retrieves a list of student assessments) |
Student Assessments | Read |
GET /v1/studentAssessments/{id} (Retrieves a specific student assessment by ID) |
Student Assessments | Read |
GET /v1/studentMedicalConditions (Retrieves a list of student medical conditions) |
Student Medical Conditions | Read |
GET /v1/studentMedicalConditions/{id} (Retrieves a specific student medical condition by ID) |
Student Medical Conditions | Read |
GET /v1/studentMedications (Retrieves a list of student medications) |
Student Medications | Read |
GET /v1/studentMedications/{id} (Retrieves a specific student medication by ID) |
Student Medications | Read |
GET /v1/studentRestrictions (Retrieves a list of student restrictions) |
Student Restrictions | Read |
GET /v1/studentRestrictions/{id} (Retrieves a specific student restriction by ID) |
Student Restrictions | Read |
GET /v1/students (Retrieves a list of students) |
Students | Read |
GET/v1/students/previousCourses (Retrieves a list of students’ previous courses) |
Students | Read |
GET /v1/students/{id} (Retrieves a specific student by ID) |
Students | Read |
GET /v1/students/{id}/accommodations (Retrieves accommodations for the specified student) |
Student Accommodations | Read |
GET /v1/students/{id}/contacts (Retrieves a list of all of the student's contacts by student ID) |
Contacts | Read |
GET /v1/students/{id}/dailyAttendance (Retrieves a list of all of the student's daily attendance) |
Daily Attendance | Read |
GET /v1/students/{id}/periodAttendance (Retrieves a list of all of the student's period attendance) |
Period Attendance | Read |
GET /v1/students/{id}/photo (Retrieves the most recent student photo for a given student) |
Student Photos | Read |
GET /v1/students/{id}/programInfo (Retrieves a list of all of the student's program information by student ID) |
Program Information | Read |
GET /v1/students/{id}/sectionEnrollments (Retrieves all of the student's current year sections) |
Section Enrollments | Read |
GET /v1/students/{studentId}/schoolEnrollments (Retrieves a list of students' school enrollment records by student id) |
School Enrollments | Read |
GET /v1/students/gradeEnrollments (Retrieves a list of students' grade enrollment records) |
Grade Enrollments | Read |
GET /v1/students/gradeEnrollments/{id} (Retrieves a specific student's grade enrollment by ID) |
Grade Enrollments | Read |
GET /v1/students/LocalId/{idNumber} (Retrieves a specific student by Local ID Number) |
Students | Read |
GET /v1/students/schoolEnrollments (Retrieves a list of students' school enrollment records) |
School Enrollments | Read |
GET /v1/students/schoolEnrollments/{id} (Retrieves a specific student's school enrollment by ID) |
School Enrollments | Read |
GET /v1/students/studentAccommodations (Retrieves a list of student accommodations) |
Student Accommodations | Read |
GET /v1/students/studentAccommodations/{id} (Retrieves a specific accommodation by ID) |
Student Accommodations | Read |
GET /v1/students/studentdocuments (Retrieves a list of student documents) |
Student Uploads | Read |
GET /v1/students/studentdocuments/{id} (Retrieves a student document by id) |
Student Uploads | Read |
GET /v1/studentusers (Retrieves a list of user ids for students) |
Student Users | Read |
GET /v1/studentusers/{id} (Retrieves a specific user id by Student ID) |
Student Users | Read |
GET /v1/subjects (Retrieves a list of subject areas) |
Subjects | Read |
GET /v1/subjects/{id} (Retrieves a specific subject area by ID) |
Subjects | Read |
GET /v1/teachers (Retrieves a list of teachers) |
Teachers | Read |
GET /v1/teachers/{id} (Retrieves a specific teacher by ID) |
Teachers | Read |
GET /v1/teachers/{id}/sections (Retrieves a list of all of the sections by teacher ID) |
Class Sections | Read |
GET /v1/teachers/{id}/students (Retrieves a list of all of the students by teacher ID) |
Students | Read |
GET /v1/timeEquivalency (Retrieves a list of time equivalencies) |
Time Equivalencies | Read |
GET /v1/timeEquivalency/{fromId}/{toId} (Retrieves a specific time equivalency by From and To period IDs) |
Time Equivalencies | Read |
GET /v1/timetableDay (Retrieves a list of timetable days) |
Timetable Day | Read |
GET /v1/timetableDay/{id} (Retrieves a specific timetable day by ID) |
Timetable Day | Read |
GET /v1/transportation/BusAssignments (Retrieves a list of student bus assignments) |
Bus Assignments | Read |
GET /v1/transportation/BusAssignments/{id} (Get a student bus assignment by ID) |
Bus Assignments | Read |
GET /v1/transportation/BusRoutes (Retrieves a list of bus routes) |
Bus Routes | Read |
GET /v1/transportation/BusRoutes/{id} (Get a bus route by ID) |
Bus Routes | Read |
GET /v1/transportation/BusRoutes/{id}/StudentBusAssignments (Retrieves a list of all student bus assignments associated with a bus route) |
Bus Assignments | Read |
GET /v1/transportation/BusRouteType (Retrieves a list of bus route / bus type associations) |
Bus Route Types | Read |
GET /v1/transportation/BusRouteType/{id} (Get a bus route / bus type association by ID) |
Bus Route Types | Read |
GET /v1/transportation/BusStop (Retrieves a list of bus stops) |
Bus Stops | Read |
GET /v1/transportation/BusStop/{id} (Get a bus stop by ID) |
Bus Stops | Read |
GET /v1/transportation/BusType (Retrieves a list of bus types) |
Bus Types | Read |
GET /v1/transportation/BusType/{id} (Get a bus type by ID) |
Bus Types | Read |
GET /v1/xcalendar (Retrieves a list of calendars in SIF xPress format) |
xCalendars | Read |
GET /v1/xcontacts (Retrieves a list of contacts in SIF xPress format) |
xContacts | Read |
GET /v1/xcourses (Retrieves a list of courses in SIF xPress format) |
xCourses | Read |
GET /v1/xleas (Retrieves a list of LEAs in SIF xPress format) |
xLeas | Read |
GET /v1/xrosters (Retrieves a list of class rosters in SIF xPress format) |
xRosters | Read |
GET /v1/xschools (Retrieves a list of schools in SIF xPress format) |
xSchools | Read |
GET /v1/xstaffs (Retrieves a list of staff members in SIF xPress format) |
xStaffs | Read |
GET /v1/xstudents (Retrieves a list of students in SIF xPress format) |
xStudents | Read |
POST /v1/assessments (Creates an assessment) |
Assessments | Create |
POST /v1/assignmentMarks (Creates an assignment mark) |
Assignment Marks | Create |
POST /v1/assignments (Creates an assignment) |
Assignments | Create |
POST /v1/assignmentStandardMarks (Creates an assignment standard mark) |
Assignment Standard Marks | Create |
POST /v1/assignmentStandards (Creates an assignment standard) |
Assignment Standards | Create |
POST /v1/categories (Creates an assignment category) |
Assignment Categories | Create |
POST /v1/categoryaverages (Creates a category average) |
Category Averages | Create |
POST /v1/classAttendanceIndicator (Creates a class attendance indicator) |
Class Attendance Indicators | Create |
POST /v1/courseAssessments (Creates a course assessment) |
Course Assessments | Create |
POST /v1/dailyAttendance (Creates a student's daily attendance) |
Daily Attendance | Create |
POST /v1/disciplineActions (Creates a discipline action) |
Discipline Actions | Create |
POST /v1/district/documenttypes (Creates a document type) |
Document Upload Types | Create |
POST /v1/finalExamMarks/{sectionId}/{studentId} (Creates a student's final exam mark) |
Final Exam Marks | Create |
POST /v1/localDisciplineIncidents (Creates a local discipline incident) |
Local Discipline Incidents | Create |
POST /v1/localDisciplineIncidents/localStudentOffender (Creates a local discipline incident offender) |
Local discipline incident offenders | Create |
POST /v1/markingPeriodMarks/{sectionId}/{studentId}/{markingPeriodId} (Creates student's marking period mark) |
Marking Period Marks | Create |
POST /v1/midtermExamMarks/{sectionId}/{studentId} (Creates a student's miterm exam mark) |
Midterm Exam Marks | Create |
POST /v1/periodAttendance (Creates student's period attendance) |
Period Attendance | Create |
POST /v1/periodAttendance/bulk (Creates period attendance in bulk) |
Bulk Period Attendance | Create |
POST /v1/progressPeriodMarks/{sectionId}/{studentId}/{progressPeriodId} (Creates student's progress period mark) |
Progress Period Marks | Create |
POST /v1/sectionMarks/{sectionId}/{studentId} (Creates a student's section mark) |
Class Section Marks | Create |
POST /v1/staff/email (Creates a staff email address) |
Staff Email | Create |
POST /v1/staff/integrationId (Creates a staff integration ID) |
Persons | Create |
POST /v1/stateDisciplineIncidents (Creates a state discipline incident) |
State Discipline Incidents | Create |
POST /v1/stateDisciplineIncidents/stateStudentOffender (Creates a state discipline incident offender) |
State discipline incident offenders | Create |
POST /v1/studentAllergies (Creates student allergy) |
Student Allergy | Create |
POST /v1/studentAssessments (Creates student's assessment) |
Student Assessments | Create |
POST /v1/studentMedicalConditions (Creates student medical condition) |
Student Medical Condition | Create |
POST /v1/studentRestrictions (Creates student restriction) |
Student Restriction | Create |
POST /v1/students/email (Creates a student email address) |
Student Email | Create |
POST /v1/students/integrationId (Creates a student integration ID) |
Students | Create |
POST /v1/students/photo (Creates a student photo) |
Student Photos | Create |
POST /v1/students/studentdocuments (Creates a student document) |
Student Uploads | Create |
POST /v1/transportation/BusAssignments (Creates a student bus assignment) |
Bus Assignments | Create |
POST /v1/transportation/BusRoutes (Creates a bus route) |
Bus Routes | Create |
POST /v1/transportation/BusRouteType/{busRouteId}/{busTypeId} (Creates a bus Route / Type association) |
Bus Route Types | Create |
POST /v1/transportation/BusStop (Creates a bus stop) |
Bus Stops | Create |
PUT /ims/oneroster/v1p1/categories/{id} (To create a new Category record or to replace one that already exists) |
OneRoster: Categories | Update |
PUT /ims/oneroster/v1p1/lineItems/{id} (Updates a line item) |
OneRoster: Line Items | Update |
PUT /ims/oneroster/v1p1/results/{id} (To create a new Result record or to replace one that already exists.) |
OneRoster: Results | Update |
PUT /v1/assignmentMarks (Updates an assignment mark) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/{id}/updateAlphaScore (Updates an assignment mark's alpha score) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/{id}/updateBonus (Updates an assignment mark's bonus) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/{id}/updateComment (Updates an assignment mark's comment) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/{id}/updatePenalty (Updates an assignment mark's penalty) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/{id}/updateScore (Updates an assignment numeric score) |
Assignment Marks | Update |
PUT /v1/assignmentMarks/UpdateOrCreate (Updates an assignment mark or create one if it doesn't exist) |
Assignment Marks | Update |
PUT /v1/assignments (Updates an assignment) |
Assignments | Update |
PUT /v1/assignments/{id}/publish (Updates an assignment's publish status) |
Assignments | Update |
PUT /v1/assignments/{id}/updateDescription (Updates an assignment's description) |
Assignments | Update |
PUT /v1/assignments/{id}/updateDueDate (Updates an assignment's due date) |
Assignments | Update |
PUT /v1/assignments/{id}/updateMaxPoints (Updates an assignment's max points) |
Assignments | Update |
PUT /v1/assignments/{id}/updateName (Updates an assignment's name) |
Assignments | Update |
PUT /v1/assignmentStandardMarks (Updates an assignment standard mark) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandardMarks/{id}/updateAlpha (Updates an assignment standard mark's alpha score) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandardMarks/{id}/updateBonus (Updates an assignment standard mark's bonus) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandardMarks/{id}/updateComment (Updates an assignment standard mark's comment) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandardMarks/{id}/updatePenalty (Updates an assignment standard mark's penalty points) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandardMarks/{id}/updateScore (Updates an assignment standard mark's score) |
Assignment Standard Marks | Update |
PUT /v1/assignmentStandards (Updates an assignment standard) |
Assignment Standards | Update |
PUT /v1/assignmentStandards/{id}/updateMaxPoints (Updates an assignment standard's max points) |
Assignment Standards | Update |
PUT /v1/categories (Updates an assignment category) |
Assignment Categories | Update |
PUT /v1/categories/{id}/updateDropHighest (Updates an assignment category's drop highest) |
Assignment Categories | Update |
PUT /v1/categories/{id}/updateDropLowest (Updates an assignment category's drop lowest) |
Assignment Categories | Update |
PUT /v1/categories/{id}/updateName (Updates an assignment category's name) |
Assignment Categories | Update |
PUT /v1/categories/{id}/updateWeight (Updates an assignment category's weight) |
Assignment Categories | Update |
PUT /v1/categoryaverages (Updates a category average) |
Category Averages | Update |
PUT /v1/dailyAttendance (Updates a student's daily attendance) |
Daily Attendance | Update |
PUT /v1/dailyAttendance/{id}/UpdateComment (Updates a student's daily attendance comment) |
Daily Attendance | Update |
PUT /v1/disciplineActions (Updates a discipline action) |
Discipline Actions | Update |
PUT /v1/district/documenttypes (Updates a document type) |
Document Upload Types | Update |
PUT /v1/finalExamMarks/{sectionId}/{studentId} (Updates student's final exam mark) |
Final Exam Marks | Update |
PUT /v1/localDisciplineIncidents (Updates a local discipline incident) |
Local Discipline Incidents | Update |
PUT /v1/localDisciplineIncidents/localStudentOffender (Updates a local discipline incident student offender) |
Local discipline incident offenders | Update |
PUT /v1/markingPeriodMarks/{id} (Updates student's marking period mark) |
Marking Period Marks | Update |
PUT /v1/markingPeriodMarks/{id}/{commented} (Applies selected comment) |
Marking Period Marks | Update |
PUT /v1/markingPeriodMarks/{id}/comment (Updates student's marking period mark's comment) |
Marking Period Marks | Update |
PUT /v1/midtermExamMarks (Updates student's midterm exam mark) |
Midterm Exam Marks | Update |
PUT /v1/periodAttendance (Updates student's period attendance) |
Period Attendance | Update |
PUT /v1/periodAttendance/{id}/UpdateComment (Updates student's period attendance comment) |
Period Attendance | Update |
PUT /v1/progressPeriodMarks/{id} (Updates student's progress period mark) |
Progress Period Marks | Update |
PUT /v1/sectionMarks/{sectionId}/{studentId} (Updates student's section mark) |
Class Section Marks | Update |
PUT /v1/stateDisciplineIncidents (Updates a state discipline incident) |
State Discipline Incidents | Update |
PUT /v1/stateDisciplineIncidents/stateStudentOffender (Updates a state discipline incident student offender) |
State discipline incident offenders | Update |
PUT /v1/studentAllergies (Updates student allergy) |
Student Allergies | Update |
PUT /v1/studentAssessments/{id} (Updates student's assessment score) |
Student Assessments | Update |
PUT /v1/students/studentdocuments (Updates a student document) |
Student Uploads | Update |
PUT /v1/studentMedicalConditions (Updates student medical condition) |
Student Medical Condition | Update |
PUT /v1/studentRestrictions (Updates student restriction) |
Student Restriction | Update |
PUT /v1/transportation/BusAssignments (Updates a student bus assignment) |
Bus Assignments | Update |
PUT /v1/transportation/BusRoutes (Updates a bus route) |
Bus Routes | Update |
PUT /v1/transportation/BusStop (Updates a bus stop) |
Bus Stops | Update |