II. Understanding Ed-Fi APIs - SEA Modernization-VDG
Eric Jansson
Vinaya Mayya
This section explains design features specific to Ed-Fi APIs and how to integrate with them. After completing this section, you should have the knowledge to connect your system to an Ed-Fi API and successfully transmit larger amounts of data.
API Routes
This section explain how the API routes work: the default locations for the various API resources provided by the Ed-Fi Operational Data Store API.
Descriptors
Descriptors are the standard "code sets" or enumerations in the Ed-Fi data model. This section explains the parts of descriptors and how they are formatted for transmission via JSON.
API Resource Keys
Ed-Fi APIs support a standard REST API resource ID for discovery and updates, but the API also supports a natural key system.
Date and DateTime Elements
Explains how date and time elements are formatted for transmission via JSON.
Dependency Ordering for Resources
In the Ed-Fi ODS / API, references to other entities must be resolvable. So, API resources have a natural dependency order and must be created in that order.