Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include Page
_Previous Version Note
_Previous Version Note

Overview


The Ed-Fi ODS / API enables applications to read and write education data stored in an Ed-Fi ODS through a secure REST interface. The REST interface to the Ed-Fi ODS / API exposes metadata describing the exposed resources as well as the inputs, HTTP verbs, and schema of the exposed entities. This metadata enables a user interface (based on the Swagger framework) to display API documentation.

The documentation pages also provide a means to interact with a sandbox version of the ODS using the API, which allows developers to experiment with API calls and to view responses in a test environment.  

Figure. Screen capture of the API documentation interface

Panel
borderColor#fec43d
bgColor#ffedc4
titleColor#000
borderWidth1
titleBGColor#fec43d
borderStylesolid
titleLinks

The following link takes you to detailed documentation for the Ed-Fi ODS / API REST Interface:

Ed-Fi ODS / API REST API Reference Documentation