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)
Apr 15, 2020
2 min read

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. 

For implementations that have no requirement to extend or customize the ODS / API, you may consider using the /wiki/spaces/EXCHANGE/pages/22487668, as an alternative to starting from source code. If you take this approach, then ignore the information on this page, and follow the instructions provided with the installers.

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
  • .Net Framework 3.5
  • Visual Studio 2017 (Community or higher)
  • Java Runtime Environment 8 or Higher
  • Microsoft SQL Server 2016 or 2017
  • Optional PostgreSQL datastore:

    • PostgreSQL 11.x. PostgreSQL can be used as the datastore for and Ed-Fi ODS / API instance instead of Microsoft SQL Server. However, Microsoft SQL Server developer edition or above is still required for a local build to support code generation.

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 2016 and 2017 (Developer Edition, Standard Edition, or Enterprise Edition)

  • Visual Studio 2017 version 15.9.11 (Community or higher)

  • JetBrains Rider 2019.1

1 SQL Server Express Edition is not supported.