A newer version of the Ed-Fi ODS / API is now available. See the Ed-Fi Technology Version Index for a link to the latest version.

Getting Started

Owned by Ian Christopher (Deactivated)
Aug 31, 2022

This documentation outlines the steps necessary to download, configure, and deploy the Ed-Fi ODS (Operational Data Store) and companion API (Application Programming Interface), referred to collectively as the Ed-Fi ODS / API. 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 Ed-Fi ODS / API supports both transactional and bulk modes of operation. 

Audience

This documentation is for technical professionals who work with educational data, including business analysts, database administrators, and software developers. The primary audiences are developers and hosts of ODS / API platforms, but developers of client applications may find this information useful. 

Additional installation options

For those interested in getting an Ed-Fi ODS / API instance up and running quickly, but do not have developer tools or experience, we recommend you consult the Docker Deployment 2.x page and the Ed-Fi Exchange, which provides a number of alternatives for installing the Ed-Fi ODS / API. These options include support for deploying into public cloud platforms including Amazon Web Services, Google Cloud, and Microsoft Azure as well as on-premises and virtual machine targets.

Tested Configurations

The Ed-Fi ODS / API configuration described in this documentation has been tested with the following software configurations:

  • Windows Server 2019, Windows 10

  • Microsoft SQL Server 2019 (Developer Edition, Standard Edition, or Enterprise Edition)

  • PostgreSQL 13.x

  • Visual Studio 2022 (Community or higher)

Contents

Find out more about how to begin using the Ed-Fi ODS / API: