API Client Developers' Guide

This documentation provides essential information for building client applications that interact with an Ed-Fi ODS / API platform. It includes instructions on generating SDKs with Swagger Tools and considerations for developing a robust and scalable solution.

Contents

• API Routes
• Authentication
• Authorization
• Basics
• Date and DateTime Elements
• Descriptor References
• Error Handling Best Practices
• Error Response Knowledge Base
• Improve Paging Performance on Large API Resources
• Introduction
• Resource Dependency Order
• Using Code Generation To Create an SDK
• Using the Online Documentation
• Using the Sandbox Administration Portal
• Using the Changed Record Queries