Getting Started - ODS / API Binary Releases

Getting Started - ODS / API Binary Releases

The Ed-Fi Alliance publishes a set of .NET binaries and databases with each ODS / API release. These binaries can be used to deploy a non-extended version of the Ed-Fi ODS / API that has the as-shipped database model. The binaries are useful for system integrators and others wanting to deploy a "core-data-model-only" ODS / API quickly and easily.

These files also support developers creating automated deployments for cloud platforms like Amazon Web Services or Microsoft Azure. Some deployments which use these binaries are currently published in the Ed-Fi Exchange.

These binaries are available for versions of the ODS / API from version 2.3.1 onwards and include minor and major point version changes. Note that patch release versions will be provided at the Alliance's discretion.

The binaries are published in a Azure Storage account at: 

https://odsassets.blob.core.windows.net/public/CloudOds/deploy/release/{version}/{filename}

The file names are:

  • EdFi.Ods.SwaggerUI.zip

  • EdFi.Ods.WebApi.zip

  • EdFi.Ods.AdminApp.Web.zip

  • EdFi_Ods.bacpac

  • EdFi_Ods_Minimal_Template.bacpac

  • EdFi_Ods_Populated_Template.bacpac

For example, the 2.6 version of the WebApi is available at:

The following binaries are also published to the Ed-Fi MyGet Feed:

Binary

Purpose

Location

Binary

Purpose

Location

EdFi.Ods.SwaggerUI

Binary for ODS / API Swagger Online documentation

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.SwaggerUI.EFA 

EdFi.Ods.Admin.Web

Binary for Sandbox Admin App

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.Admin.Web.EFA 

EdFi.Ods.WebApi

Binary for ODS REST APIs

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.WebApi.EFA 

EdFi.OdsApi.Sdk

Binary for ODS / API SDK

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.OdsApi.Sdk 

EdFi.RestApi.Databases

Binary for ODS / API database scripts

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.RestApi.Databases.EFA 

EdFi.Samples.Ods

Ed-Fi Populated Template database backup

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Samples.Ods 

EdFi.Ods.SecurityConfiguration.Administration.Web

Binary for Security Configuration Tool

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.SecurityConfiguration.Administration.Web.EFA 

EdFi.Ods.SecurityConfiguration.KeyRetrieval.Web

Binary for Key Retrieval Tool

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.SecurityConfiguration.KeyRetrieval.Web.EFA 

EdFi.Ods.BulkLoad.Services.Windows.UploadWorker

Binary for MSMQ monitor service used by bulk load API

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.BulkLoad.Services.Windows.UploadWorker.EFA 

EdFi.Ods.BulkLoad.Services.Windows.BulkWorker

Binary for MSMQ monitor services used by bulk load API

https://www.myget.org/feed/ed-fi/package/nuget/EdFi.Ods.BulkLoad.Services.Windows.BulkWorker.EFA