Tech Docs

These documents provide conceptual and reference information necessary to implement Ed-Fi technology in your environment or as part of products and services that you provide to others. The material is intended for a technical audience familiar with both XML and database development. If you are looking for older versions of these materials, refer to the bottom of this page. If you wish to receive email updates when these documents are updated, please use the registration box on the right.

Ed-Fi REST API Development Kit RFC

RFC Announcement Link to the Ed-Fi REST API Development Kit RFC announcement and webinar details.
RFC Materials Link to the materials that will be made available during the Ed-Fi REST API Development Kit RFC.

Documents

What’s New (Brief)   v1.2  Find out more about what’s new in version 1.2.
What’s New (Full)   v1.2 Find out more about what’s new in version 1.2.
Student Performance Dashboard Metrics   v1.2 Explains the educational metrics that elementary and secondary teachers have identified as critical to understanding students’ strengths and areas for improvement. It also includes the metrics that school and district leaders have identified as critical to performing their responsibilities.
Technical Concepts   v1.2 Outlines the design concepts, principles, patterns and conventions used for the Ed-Fi unifying data model and its associated XML core schema.
REST API Design Guidelines   v1.2 Defines a set of design guidelines that should be adhered to when implementing an Ed-Fi REST API over an Ed-Fi application or data store.
Validation Tool Getting Started Guide   v1.1 Introduces the Ed-Fi Validation Tool and provides a step-by-step guide for how to create and run validation tests.
Standard Interchange Schemas Overview   v1.2 Introduces a set of 19 Standard Interchange Schemas that represent field-tested schema based on the unmodified, non-extended Ed-Fi Core to handle common data exchange use-cases
Standard Interchange Schema Briefs   v1.2 Provides detailed information about each of the Standard Ed-Fi Interchange Schemas
Extension Framework Guide   v1.2 Explains how to safely customize Ed-Fi data types by creating Ed-Fi extension schema.
Unifying Data Model   v1.2 Illustrates the Ed-Fi reference model in Unified Modeling Language (UML) class diagrams.
CEDS 3.0 Alignment Approach for Ed-Fi v1.2   v1.2  Provides a detailed, initial comparison of CEDS 3.0 and Ed-Fi v1.1.1 and describes the Ed-Fi Alliance’s approach for addressing alignment in Ed-Fi v1.2.

Schema

Ed-Fi Core XML Schema   v1.2 The central XML schema definition (XSD) that defines a base set of data elements, attributes, types and structures that are intended for use across the rest of the Ed-Fi components. The core schema serves the majority of schools’ educational needs and provides the building blocks for additional schema, such as the interchange and extension schema
Data Handbook for the Core XML Schema   v1.2 Describes all of the core schema elements and their properties using non-technical language.
Ed-Fi Standard Interchange Schemas with Sample Data   v1.2 Examples of how to write interchange schema to define relationships between elements that are re-used from the core schema, along with newly defined elements. Sample Descriptor values for Ed-Fi vocabularies and CEDS option sets are also included in this package.
Extension Schema Example – Custom Student Transcript   v1.2 Example of an extension schema to load a student transcript generated by a high school for a post-secondary institution.
XML Data Dictionary for Core XSD   v1.2 Describes all of the core schema complex and simple types.

Database

Logical Database Model   v1.2 Graphical guide to Ed-Fi Logical Database Model, based on a relational database schema that is aligned with the reference Ed-Fi Unifying Data Model.
SQL Data Dictionary for the Ed-Fi Operational Data Store   v1.2 Documentation for the entities and fields in the Ed-Fi relational data tables.
Ed-Fi Operational Data Store SQL Script   v1.2 Sample Microsoft SQL Server 2008 script file to create an empty database for an Ed-Fi Operational Data Store.

 

Looking for Older Versions?