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 audience is developers and hosts of ODS / API platforms, but developers of client applications may find this information useful.

Prerequisites

The Ed-Fi ODS / API technology is free to license and use. Access to the Ed-Fi repository on GitHub is required to download the Ed-Fi ODS / API technical material. Click here for more information.

Familiarity with the following technologies is required for installing and configuring the software components:

Microsoft Windows (installation and configuration)
PowerShell
Visual Studio 2017* (Community or higher) or Visual Studio 2015 (Professional or higher)
- ASP.NET MVC 4/C#
- NuGet (Package Manager)
Microsoft SQL Server 2014
- SQL Server Management Studio (SSMS)

Tested Configurations

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

Windows Server 2016, Windows 10
Microsoft SQL Server 2014 (Developer Edition, Standard Edition, or Enterprise Edition)
Visual Studio 2017* (Community or higher)
Visual Studio 2015 (Professional or higher)

* There is a known issue with Visual Studio 2017 version 15.7.6. Details and workarounds are in the Ed-Fi Tracker (ticket ODS-2478).

¹ SQL Server Express Edition is not supported.

Browser not supported