Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Eindhoven University of Technology education API

The education API from Eindhoven University of Technology — 14 operation(s) for education.

Eindhoven University of Technology education API is one of 38 APIs that Eindhoven University of Technology publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include education. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 14 paths, and defines 30 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.

Requests are made against a single base URL, /ws/api.

18 operations 14 paths 30 schemas 1 DELETE11 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.3-4
Base URL
https://pure.tue.nl/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Eindhoven University of Technology education API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 1 DELETE, 11 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

education 18
GET
/educations
Lists all educations
education_list 3 params → 200
PUT
/educations
Create education
education_create body → 201400409
GET
/educations/allowed-education-types
A list of allowed funding classifications
education_getAllowedEducationTypes → 200
GET
/educations/allowed-keyword-group-configurations
A list of keyword group configurations
education_getAllowedKeywordGroupConfigurations → 200
GET
/educations/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
education_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/educations/allowed-link-types
A list of allowed link types
education_getAllowedLinkTypes → 200
GET
/educations/allowed-locales
A list of allowed locales in localized strings
education_getAllowedLocales → 200
GET
/educations/allowed-types
A list of allowed education types
education_getAllowedTypes → 200
GET
/educations/orderings
Lists available orderings
education_getOrderings → 200
POST
/educations/search
Query operation for education
education_query body → 200400
GET
/educations/{uuid}
Get education
education_get 1 param → 200301404
PUT
/educations/{uuid}
Update education
education_update 1 param body → 200400404
DELETE
/educations/{uuid}
Delete education
education_delete 1 param → 204404409
POST
/educations/{uuid}/actions/lock
Lock the content
education_lock 1 param → 204404409
POST
/educations/{uuid}/actions/unlock
Unlock the content
education_unlock 1 param → 204404409
GET
/educations/{uuid}/dependents
Lists all dependents to the education
education_dependents 2 params → 200
GET
/educations/{uuid}/notes
Lists notes
education_listNotes 3 params → 200404
PUT
/educations/{uuid}/notes
Create note
education_createNote 1 param body → 200400

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Education (27 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties), EducationQuery (6 properties). Each schema is shown below with its type and property counts.

PageInformation
object
Information about pages
2 properties
ContentRef
object
2 properties 2 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
EducationListResult
object
List of educations. Can contain a subset of all items along with the full count
3 properties
Education
object
An education
27 properties 4 required
DateRange
object
A date range
2 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
LinkIdentifier
object
A link identifier
2 properties
ContentRefListResult
object
List of Content Refs
1 property
Note
object
A note
3 properties 1 required
NoteListResult
object
List of notes
3 properties
Visibility
object
Visibility of an object
2 properties 1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
SemesterRef
object
A reference to semester
1 required
LocalesList
object
List of available locales
1 property
Identifier
object
1 property 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
EducationRef
object
A reference to Education
1 required
KeywordGroup
object
4 properties 2 required
ProblemDetails
object
RFC7807 Error details
5 properties
ClassificationRef
object
A reference to a classification value
2 properties 1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
OrderingsList
object
List of available orderings
1 property
SpecializationRef
object
A reference to a specialization
1 required
ClassificationRefList
object
List of classification references
1 property
EducationQuery
object
Create a query for education
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eindhoven-university-of-technology-education-api-openapi.yml Raw ↑

Other APIs Eindhoven University of Technology publishes across the network.

TU/e Research Portal OAI-PMH
Eindhoven University of Technology activity API
Eindhoven University of Technology application API
Eindhoven University of Technology authorCollaboration API
Eindhoven University of Technology award API
Eindhoven University of Technology classificationScheme API
Eindhoven University of Technology concept API
Eindhoven University of Technology conferenceSeries API
Eindhoven University of Technology contract API
Eindhoven University of Technology course API
Eindhoven University of Technology dataSet API
Eindhoven University of Technology equipment API