generated: '2026-10-09' method: derived generator: derive-vocabulary.py source: - openapi/open-education-api-openapi.yml - openapi/open-education-api-v5-openapi.yml vocabulary: name: Open Education API Domain Vocabulary description: 'Terms declared by Open Education API''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-09' terms: - term: academic sessions definition: The academic sessions API provides information about the different time periods a programme can be offered. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: academic_session_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: associations definition: The association API is now deprecated and has been replaced by more specific endpoints programme-offering-association, course-offering-association, learning-component-offering-association and test-component-offering-association. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: building_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: buildings definition: The building API provides a building that is currently used by the organisation. It includes all location details. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: components definition: This path is no longer supported; you can now use learning components or test components. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: course offering associations definition: The course offering associations API provides information about the association between a course offering and a person (e.g. students, lecturers, etc). Associations can be posted between institutions. This requires detailed information on the course offering and the persons. To allow for this information a complete person object and offering object can be part of the API. The structure is explaine tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: course offerings definition: The offerings API provides information about offerings which have a global timeframe, e.g. a period to which students can enrol. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: course_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: course_offering_association_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: course_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: courses definition: The courses API provides a self-contained and formally structured learning experience, aimed at delivering defined learning outcomes to students, usually within the context of a programme. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: data_model definition: 'The Open Education API defines different objects using schemas. These schemas are based on OpenAPI base types, with occasional specific amendments to these base types. The types we use are: The data type of a schema is defined by the type keyword, for example, type: string. OpenAPI defines the following basic types: - [string](#strings) (this includes dates and files) - number - integer - boolean ' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: document_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: documents definition: The API for accessing and retrieving document resources. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: group_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: groups definition: 'The groups API provides information about groups that are related to organisations, persons and offerings. Groups of students that are related to an offering are typically used for rostering. The rostering application assigns students based on these groups. For example, class 1b will be assigned to the course offering on Monday morning. Not all groups are related to an offering. A group of people ' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning component offering associations definition: The API for associations between persons and learning component offerings. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning component offerings definition: The offerings API provides information about learning component offerings which have a global timeframe, e.g. a period to which students can enrol. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning components definition: The learning components API provides information about learning activities that are part of a course (or learning component). tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning outcomes definition: The learning outcomes API provides information about the statements regarding what a learner knows, understands and is able to do on completion of a learning process, which are defined in terms of knowledge, skills and responsibility and autonomy. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning_component_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning_component_offering_association_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning_component_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: learning_outcome_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: membership_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: memberships definition: The memberships API provides information about memberships that are related to groups and persons. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: news definition: This path is no longer supported. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: organisation_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: organisations definition: The organisations API provides the organisations that are responsible for the execution and recognition of education, either as an educational institution or as an organisation providing services, internships or facilities. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: person_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: persons definition: The persons API provides information about persons related to an organisation. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programme offering associations definition: The programme offering associations API provides information about the association between a programme offering and a person (e.g. students, lecturers, etc). Associations can be posted between institutions. This requires detailed information on the programme offering and the persons. To allow for this information a complete person object and offering object can be part of the API. The structure is tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programme offerings definition: The offerings API provides information about programme offerings which have a global timeframe, e.g. a period to which students can enrol. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programme_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programme_offering_association_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programme_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: programmes definition: The programmes API provides a coherent set of educational components, aimed at the realisation of competences or objectives in the field of knowledge, insight, attitudes and skills that the person who completes the programme must have. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: room_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: rooms definition: The rooms API provides the part of a building where an activity can take place. Including detailed information on the resources available, number of seats, etc. (Updated continuously) tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: security definition: Within the specification, no global security is defined. This keeps the core specification neutral and avoids prescribing a single security model for all operations. For those API calls that require authentication or authorisation, this is explicitly indicated in the accompanying documentation. By leaving the global security section empty, implementation details are separated from the functional d tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: service metadata definition: The service API provides additional metadata needed to make the OEAPI fit for this organisation. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: service_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test component offering association attempts definition: The API for the attempts that are made by a person on a test component offering association. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test component offering associations definition: The API for associations between persons and test component offerings. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test component offerings definition: The offerings API provides information about test component offerings which have a global timeframe, e.g. a period to which students can enrol. tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test components definition: The test components API provides information about test or assessment activities that are part of a course (or learning unit). tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test_component_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test_component_offering_association_attempt_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test_component_offering_association_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: test_component_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-openapi.yml - term: education specifications definition: The education specification API provides information on the specification of an education object. This specification allows for other education objects to be derived from it. It is used to aggregate education objects from a supplying institution. It clusters programs to a main educationSpecification that is used in registries such as RIO. tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: offerings definition: The offerings API provides information about offerings which have a global timeframe, e.g. a period to which students can enroll. tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: organizations definition: The organizations API provides the organizations that are responsible for the execution and recognition of education. tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: programs definition: The programs API provides a coherent set of educational components, aimed at the realization of competences or objectives in the field of knowledge, insight, attitudes and skills that the person who completes the program must have. tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: education_specification_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: program_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: component_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: program_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: component_offering_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: association_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: organization_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: news_feed_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: news_item_model definition: '' tags: - Resource Group source: openapi/open-education-api-v5-openapi.yml - term: Service definition: A metadata set providing details on the provider of this OEAPI implementation tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Service - term: AcademicSession definition: A named period of time that can be used to communicate the various schedules and time periods an institution recognizes and uses to organise their education. AcademicSessions can be nested. Offerings MAY be linked to a specific AcademicSession to indicate that the specified Offering takes place during the AcademicSession, however this is not mandatory. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/AcademicSession - term: Building definition: An object describing a building and the properties of a building. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Building - term: LearningComponent definition: A component is a part of a course tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/LearningComponent - term: TestComponent definition: A component is a part of a course tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/TestComponent - term: Membership definition: A membership contains the information on a membership of a person for a specific group tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Membership - term: LearningOutcome definition: statements regarding what a learner knows, understands and is able to do on completion of a learning process, which are defined in terms of knowledge, skills and responsibility and autonomy (https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32017H0615(01)&from=EN) tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/LearningOutcome - term: Organisation definition: A description of a group of people working together to achieve a goal tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Organisation - term: Room definition: An area within a building where education can take place tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Room - term: TestComponentOfferingAssociationAttempt definition: Planning and execution information on an attempt belong to a TestComponentOfferingAssociation. Result on the attempt is only relevant when a score or rawScore can be determined. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/TestComponentOfferingAssociationAttempt - term: expandableObjects definition: 'The object that can be expanded for this path. - academic_session: the academicSession object can be expanded. - building: the building object can be expanded. - child: the child object (which is an instance of the current object) can be expanded. - children: a set of objects (which are an instance of the current object) can be expanded. - coordinators: the person object indicating a coordinator c' tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/expandableObjects - term: Ext definition: Object for additional non-standard attributes tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Ext - term: Problem definition: A problem details object, conforming to RFC 7807 (Problem Details for HTTP APIs). See https://datatracker.ietf.org/doc/html/rfc7807. It provides a machine-readable format for error conditions, including a type URI, title, status code, and optional detail and instance fields. This ensures consistent handling of error responses across the API. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Problem - term: type definition: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/type - term: title definition: A short, human-readable summary of the problem type tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/title - term: Consumer definition: The additional elements of a consumer that may be provided, see the [documentation on support for specific consumers](https://oeapi.eu/v6.0/#/technical/consumers-and-profiles/) for further information about this mechanism. tags: - Object source: openapi/open-education-api-openapi.yml#/components/schemas/Consumer