Ed-Fi API Design and Implementation Guidelines

Version: 4.0
Obsoletes: Ed-Fi API Design & Implementation Guidelines v3.1
Obsoleted By: --
Status: Current

Ed-Fi Alliance
Contact: Stephen Fuqua
May 2024

This document describes 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

Date

Version

Change

Date

Version

Change

May 2024

v4.0

Substantial revisions compared to v3.1.

July 2, 2024

v4.0.1

Corrections to copy & paste errors in HTTP status codes on the Delete page.

Also see Summary of Changes for Ed-Fi API Guidelines, Version 4.0

Contents

Also see source code repository Ed-Fi-API-Standards for draft revisions, API specification files, and other related documents.

Â