Change Updates

Do not miss any Connect API changes, ever again

Subscribe to the Connect API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare

 New Features

Disable User (POST /users/{userId}/disable): This endpoint disables a user by the given userId.

1 structure change including:
1 Addition
Added 1
POST /users/{userId}/disable

We've added a convenient "Share Feedback" link to our Connect API documentation. This makes it easier for you to provide feedback or report issues directly to our team. Simply click the link and share your thoughts. Your input is invaluable in helping us improve the API and better serve your needs.

We hope you find this new feature helpful!

New Features

Create Class (POST /classes): Create classes within an academic year

Get Class (GET /classes/{classId}): Get a class by ID

Assign Class Teachers (POST /classes/{classId}/teachers): Assign one or more teachers to a class

Assign Class Students (POST /classes/{classId}/students): Assign one or more students to a class

Create Cohort (POST /smart-ia/cohorts): Create cohorts within an academic year

Get Cohort (GET /smart-ia/cohorts/{cohortId}): Get a cohort by ID

6 structure changes including:
6 Additions
Added 6
GET /classes/{classId}
GET /smart-ia/cohorts/{cohortId}
POST /classes
POST /classes/{classId}/students
POST /classes/{classId}/teachers
POST /smart-ia/cohorts

 New Features

Remove Student Classes (POST /students/{userId}/classes): This endpoint removes a list of classes from a student.

Remove Teacher Classes (POST /teachers/{userId}/classes): This endpoint removes a list of classes from a student.

2 structure changes including:
2 Additions
Added 2
DELETE /students/{userId}/classes
DELETE /teachers/{userId}/classes

New Features

List Users (GET /users): This endpoint retrieves a list of users. Ideal for basic filtering or fetching all users.

Search Users (POST /users/search): This endpoint provides the same filtering options and response as List Users. Use this if filtering by a large number of values.

Improvements

Added "roles" field to the User Model: The User model now includes a roles field that lists all of the user's platform roles.

Added "createdAt" field to the User Model: The User model now includes a createdAt field that has an ISO 8601 formatted datetime string of the date the user was created

Added "updatedAt" field to the User Model: The User model now includes a updatedAt field that has an ISO 8601 formatted datetime string of the date the user was last updated

4 structure changes including:
2 Additions
2 Modifications
Modified 2
POST /students
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
POST /teachers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
Added 2
GET /users
POST /users/search
12 structure changes including:
8 Additions
4 Modifications
Modified 4
GET /smart-ia/sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /smart-ia/sessions/completed
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /smart-ia/sessions/in-progress
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /smart-ia/sessions/search
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Added 8
GET /academic-years
GET /academic-years/current
GET /academic-years/{academicYearId}
POST /students
POST /students/{userId}/classes
POST /students/{userId}/cohorts
POST /teachers
POST /teachers/{userId}/classes
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /smart-ia/sessions
  • Query
  • externalId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /smart-ia/sessions/completed
  • Query
  • externalId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

GET /smart-ia/sessions/in-progress
  • Query
  • externalId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before

      Breaking

POST /smart-ia/sessions/search
  • Body
  • application/json content type Modified
    • search property Modified
      • externalIds property Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /smart-ia/sessions
  • Query
  • sort query parameter Modified
GET /smart-ia/sessions/completed
  • Query
  • sort query parameter Modified
GET /smart-ia/sessions/in-progress
  • Query
  • sort query parameter Modified
POST /smart-ia/sessions/search
  • Body
  • content type Modified
    • sort property Modified
4 structure changes including:
4 Modifications
Modified 4
GET /smart-ia/sessions
  • Response
  • 200 response Modified
    • data property Modified
GET /smart-ia/sessions/completed
  • Response
  • 200 response Modified
    • data property Modified
GET /smart-ia/sessions/in-progress
  • Response
  • 200 response Modified
    • data property Modified
POST /smart-ia/sessions/search
  • Response
  • 200 response Modified
    • data property Modified