This documentation describes concepts and techniques necessary for a technical professional to understand and successfully exchange information with an Ed-Fi ODS / API.
Audience
This documentation is for current and prospective ODS / API client implementers. Client implementers are generally software developers, database administrators, or data integration developers. Client implementers interested in the inner workings of an Ed-Fi ODS / API platform may also find the Platform Developers' Guide useful. Similarly, ODS / API platform hosts may find this information useful.
Prerequisites
To gain the most benefit from this documentation, the reader should already be familiar with the following knowledge areas:
- Ed-Fi technology, see www.ed-fi.org
- 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