Ed-Fi REST API Specifications

The Ed-Fi Data Standard contains normative and non-normative specifications for RESTful APIs. This section contains those specifications.

Audience

There are two audiences for these specifications. The primary audience is developers of an Ed-Fi REST API who are creating API implementations based on the Ed-Fi Data Standard. The secondary audience is application developers who may find the guidelines useful when building client applications that interact with an Ed-Fi REST API.

Prerequisites

To gain the most benefit from these guidelines, you should be familiar with the following knowledge areas:

• Representational state transfer (REST) services, see https://www.ics.uci.edu/~fielding/pubs/dissertation/fielding_dissertation.pdf, Chapter 5
• OAuth2, see https://tools.ietf.org/html/rfc6749
• JavaScript Object Notation (JSON), see http://www.json.org