Upcoming Change for Schoology API Consumers

Overview

We require that all consumers of the Schoology public API ensure that numeric values used to represent an identifier (id) in Schoology are stored in a data type that can represent very large values. We encourage any consumer of the Schoology API to check your system and make any necessary changes in order to continue scaling the Schoology solution, ensuring that our integrated applications continue to be available in the future.

Failure to make any necessary changes by July 1, 2019 will break compatibility with Schoology and could result in an inoperable solution. We recommend meeting this requirement by storing these ids in a “string” data type (with a minimum of 36 characters.

Why July 1, 2019?

On July 1, 2019, Schoology will exceed the max value that a 32-bit signed integer can store. Because of this, we are encouraging any consumer of the Schoology API to check your system and make any necessary changes to support very large values as soon as possible. This will ensure that districts are successfully prepared.

As an API Consumer, how should I prepare?

The only requirement for API Consumers is to handle identifiers that exceed the max value of a 32-bit signed integer, which will be 10 digit numbers. However, it is strongly encouraged that these identifiers are stored as 36 character strings for future flexibility.

If I have a Schoology Test Environment, can I test changes beforehand?

For districts that have access to a Schoology Test environment, beginning April 1, 2019, the identifiers will be configured to exceed the 32-bit signed integer threshold. This will allow consumers of the Schoology API to validate that their clients will function properly with these very large id values.