Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Ed-Fi API Specifications

Resource API

The Ed-Fi Unifying Data Model(UDM) provides the basis for the data transferred and manipulated by an Ed-Fi REST API implementation. The Ed-Fi UDM is a structured, conceptual model of common K–12 education data. The model includes entities that are easily recognized by educators and administrators: schools, students, teachers, attendance, grades, assessment results, and many others. These entities contain attributes (i.e., properties) that are also easily recognized. For example, assessment results contain data, such as a score and the date the assessment was administered. The UDM also includes associations (i.e., relationships) between entities, such as the association between students and schools.

...

Entities are abstract concepts. They are implemented as "models" that define data types, validation requirements, and inter-relationships. The words are loosely interchangeable.

Also see Resources.

Discovery API

The Ed-Fi Discovery API presents clients with configuration information about a running application, including:

...

The Discovery API allows client developers to build applications that need know only one base URL, can extract runtime information from it, and alter behavior as appropriate.

Also see Discovery API .

Other API Specifications

...

Other specifications managed by the Ed-Fi Alliance include:

  • Ed-Fi Descriptors API

  • Ed-Fi Admin API

  • Ed-Fi Identity API

  • Ed-Fi Change Queries API

  • Ed-Fi Enrollment API

  • various profiles of the Resource API

  • and others as may be defined from time to time.

...