Product: Ed-Fi API Design & Implementation Guidelines
Version: 3.1
Generation: Technical Suite 3
Obsoletes: Ed-Fi API Design & Implementation Guidelines v3.0
Obsoleted By: --
Status: Current 

Ed-Fi Alliance
Contact: Eric Jansson
January 31, 2019

This section provides design guidelines for an Ed-Fi representational state transfer (REST) application programming interface (API). These guidelines describe the properties to which an API specification and related implementation must adhere in order to be considered aligned to Ed-Fi technology standards. They are guidelines only. They do not describe a specific implementation or particular API specification. Where helpful, a rationale for specific guidelines is also provided.

Version History

January 31, 2019v3.1Added key and field unification requirement to Resource section. Minor non-substantive and formatting edits.


  • No labels