SylogistEd Student Information System API

API Home

The SylogistEd Student Information System API is an application programming interface (API) that allows school district and third-party vendor developers (API Developers) the ability to access data objects and service methods with the SylogistEd Student Information System.

The API is implemented as a Representational State Transfer (REST) API using the Hypertext Transfer Protocol (HTTP) Request and Response model.

For more information on Authentication and API route end-points »

The API requires three pieces of information to authenticate; API Key, Username, Password.

An API Key is required to authenticate to the API. In order to get an API Key, the API Developer must first register with Municipal Accounting Systems, Inc. We will generate the API Key and register the API Developer. If a school district is allowing a third-party vendor to access the API for their school district, then only the third-party vendor is required to register for the API Key. Only one API Key is required per API Developer. If a third-party vendor is working with multiple school districts, they will only register once and the API Key can be used for each school district.

A user must be created in SylogistEd Account Managment to provide the API Developer access to the appropriate students and data objects for the school district. This user will be set up and managed by the school district.

Over time, we will update the API. By default, version 1.0 of the API will be returned. If the version is specified when creating the JSON Web Token (JWT), the JWT will contain the version. If the version is not specified when creating the JWT, the version can be specified with the HTTP Request. To specify a newer version, you can specify the ApiVersion as a query string parameter or by setting the ApiVersion in the Accept header of the HTTP Request. Our standards for providing updates to the API are as follows:

  • We will not change existing route end-points.
  • We may deprecate or remove route end-points. A notification will be sent to the API Developers.
  • We may add new route end-points to extend the functionality of the API. Adding new end-points will not affect the version of the API. A notification will be sent to the API Developers.
  • We will not rename or remove existing data object properties.
  • We may add new properties to existing data objects. Adding new properties to existing data objects will not affect the version of the API. Note: Because we may add properties to existing data objects, do not rely on the order of the properties. A notification will be sent to the API Developers.
  • All other revisions to the API will require a new version of the API. Only the affected data objects and service methods will receive a new version. A notification will be sent to the API Developers.

The default response format is JavaScript Object Notation (JSON). However, the API can also return Extensible Markup Language (XML). If the response format is specified when creating the JWT, the JWT will contain the response format. If the response format is not specified when creating the JWT, the response format can be specified with the HTTP Request. To specify XML as the response format, you can specify the ApiFormat as a query string parameter or by setting the MIME-Type in the Accept header of the HTTP Request.

The precedence for determining the values to use for the Response Format and Version is as follows. Values passed with the JWT will override the header values. Values passed as query string parameters will override the JWT.