This version of the Ed-Fi ODS / API is no longer supported. See the Ed-Fi Technology Version Index for a link to the latest version.

 

Getting Started

Owned by Ian Christopher
Last updated: Mar 12, 2017
1 min read

Previous Version

This is a previous version of Ed-Fi technology. Visit the Ed-Fi Tech Docs home page for a link to the current version, or the Ed-Fi Technology Version Index for links to all versions. 

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 2013 (Professional Edition or higher)
    • ASP.NET MVC 4/C#
    • NuGet (Package Manager)
  • Microsoft SQL Server 2012
    • 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 2012, Windows 7 or 8 Professional (64-bit) and Ultimate (64-bit)

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

  • Visual Studio 2013 with Update 3 (Professional Edition or higher)

 

The Ed-Fi Alliance's continuous integration and QA environments use the configuration specified above. The Ed-Fi ODS / API is also expected to work with Microsoft SQL Server 2014 and Visual Studio 2015, however these editions have not been exhaustively tested.

1 SQL Server Express Edition is not supported.