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

 

API Design & Implementation Guidelines

Owned by Ian Christopher
Last updated: Sep 12, 2018 by Ian Christopher (Deactivated)

The design and implementation guidelines herein supersede the previous guidelines associated with Ed-Fi Data Standard v2.0. The previous version can be found /wiki/spaces/TT/pages/18645497.

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.

Contents