Platform Updates

API Updates

• Initial release of 2.0.0.
  • We do not have plans to deprecate v1 at this time.
  • We will continue to make improvements and fix issues in the v1 API.
• Lexical updates:
  • Organizations have been split into several new types: Districts, Schools, Classes, and Sections.
  • v1.0 Courses have been renamed to Classes to fall more in line with industry expectations.
  • We have added a brand new type Courses to represent the concept of a course "template".
  • Courses are designed to capture the concept of "Algebra 1", rather than a specific instantiation of a class.
  • Classes differ as they are comprised of teachers and students in a room (i.e. at a specific time).
  • Classes may reference a course.
  • We have added the type agents to describe the parent/guardian to student relationship.
  • We have renamed v1.0 Terms to v2.0 Sessions in order to represent a wider array of time-bound objects.
  • Enrollments are now only between a Person and a corresponding Class.
  • They may optionally include a reference to a section which is a group of students within a class.
  • All sources will now have a single district object and one or more school objects.
  • This was not necessarily the case in v1.0 where this was determined by the LMS that the district used.
  • A number of name changes were made to improve consistency across the API.
• You will now find a reference to the district and zero or more schools on each person object.
  • This replaced the old style of having enrollments connect users to their school or district.
• We have introduced the global role of district-administrator as it was a source of confusion to represent all administrators as simply administrator.
• People may now have more than one global role.
• We have improved the way we handle our event deltas to make them more clear for developers.
• Additional notes:
  • Authentication and authorization have not changed. You can use the same tokens to call v1 and v2 endpoints.
  • At the end of the day, you should receive the same information from v1 as v2, just in a considerably different format.
  • New features like agents or courses will not be available through the v1 API.