Skip to end of metadata
Go to start of metadata

Routes are names used to access endpoints and are used in API URLs. This section describes the patterns and conventions of routes in the Ed-Fi ODS / API.

Route Patterns in Ed-Fi APIs

The Ed-Fi ODS / API uses the following route structure to support multiple Extensions and to provide support for API versioning:

DescriptionODS / API Route
Base URI

/{api_area}/{version}/{year}*

Examples:
/data/v3
/composites/v1
/identity/v2
/bulk/v1

Basic Relative URL Format

Data Management Resources:
…/{org}/{resource}

API Composites:
.../{org}/{category}/{resource}

Examples
Resources (Ed-Fi)/data/v3/ed-fi/schools
Descriptors (Ed-Fi)/data/v3/ed-fi/termDescriptors
Resources (Host Extensions)/data/v3/TX/leavers
Resources (Domain Extensions)/data/v3/talentMgmt/applicants
Composites (Ed-Fi)**/composites/v1/ed-fi/assessment/studentAssessments
Composites (Host Organization)/composites/v1/MI/enrollment/Schools
Composites Based on Domain or Host ExtensionsUnsupported
Bulk/bulk/v1/bulkOperations
Identity/identity/v2/identities

Notes:

* School Year is optional in the route
** Composites are treated as a reserved word

Separate Bulk and Identity Endpoints

The endpoints for bulk and identity features are clearly separated. This allows separate versioning for these features, and also supports implementations that are not using the optional identity and bulk features.

Examples include:

  • /data/v3
  • /identity/v2
  • /bulk/v1


  • No labels