Eindhoven University of Technology course API

The course API from Eindhoven University of Technology — 27 operation(s) for course.

Documentation Provider Profile APIs.io OpenAPI GitHub

Eindhoven University of Technology course 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 course. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 31 operations across 27 paths, and defines 39 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.

31 operations 27 paths 39 schemas 1 DELETE23 GET3 POST4 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

Contact

pure-support@elsevier.com

Resource Areas

Authentication & Security 1

Eindhoven University of Technology course 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 31

Across 27 paths, the API surfaces 31 operations — 1 DELETE, 23 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

course 31

GET

/courses

Lists all courses

course_list 3 params → 200

PUT

/courses

Create course

course_create body → 201400

GET

/courses/allowed-classified-identifier-types

A list of allowed classified identifier types

course_getAllowedClassifiedIdentifierTypes → 200

GET

/courses/allowed-course-file-access-types

A list of allowed access types for course files

course_getAllowedCourseFileAccessTypes → 200

GET

/courses/allowed-course-file-license-types

A list of allowed license types for course files

course_getAllowedCourseFileLicenseTypes → 200

GET

/courses/allowed-course-file-types

A list of allowed file types for course files

course_getAllowedCourseFileTypes → 200

GET

/courses/allowed-course-occurrence-lecturer-role-types

A list of allowed role types for course lecturers on a given course occurrence

course_getAllowedCourseOccurrenceLecturerRoleTypes → 200

GET

/courses/allowed-course-occurrence-semester-types

A list of allowed semester types for course occurrences

course_getAllowedCourseOccurrenceSemesterTypes → 200

GET

/courses/allowed-credit-types

A list of allowed credit types

course_getAllowedCreditTypes → 200

GET

/courses/allowed-custom-defined-field-values/{propertyName}/classifications

Get allowed classifications for the custom-defined field associated with the course

course_getAllowedCustomDefinedFieldClassifications 1 param → 200400404

GET

/courses/allowed-description-types

A list of allowed description types

course_getAllowedDescriptionTypes → 200

GET

/courses/allowed-formats

A list of allowed formats

course_getAllowedFormats → 200

GET

/courses/allowed-image-types

A list of allowed image types

course_getAllowedImageTypes → 200

GET

/courses/allowed-keyword-group-configurations

A list of keyword group configurations

course_getAllowedKeywordGroupConfigurations → 200

GET

/courses/allowed-keyword-group-configurations/{id}/classifications

A list of allowed classifications for the specified keyword group

course_getAllowedKeywordGroupConfigurationClassifications 1 param → 200

GET

/courses/allowed-languages

A list of allowed languages

course_getAllowedLanguages → 200

GET

/courses/allowed-levels

A list of allowed levels

course_getAllowedLevels → 200

GET

/courses/allowed-link-types

A list of allowed link types

course_getAllowedLinkTypes → 200

GET

/courses/allowed-locales

A list of allowed locales in localized strings

course_getAllowedLocales → 200

GET

/courses/allowed-types

A list of allowed course types

course_getAllowedTypes → 200

GET

/courses/allowed-workflow-steps

A list of allowed workflow steps in localized strings

course_getAllowedWorkflowSteps → 200

PUT

/courses/file-uploads

Upload file to a specific course

course_fileUploads 1 param body → default

POST

/courses/search

Query operation for courses

course_query body → 200400

GET

/courses/{uuid}

Get course

course_get 1 param → 200301404

PUT

/courses/{uuid}

Update courses

course_update 1 param body → 200400404409

DELETE

/courses/{uuid}

Delete course

course_delete 1 param → 204404409

POST

/courses/{uuid}/actions/lock

Lock the content

course_lock 1 param → 204404409

POST

/courses/{uuid}/actions/unlock

Unlock the content

course_unlock 1 param → 204404409

GET

/courses/{uuid}/files/{fileId}

Get file from the course

course_getFile 2 params → 200

GET

/courses/{uuid}/notes

Lists notes

course_listNotes 3 params → 200404

PUT

/courses/{uuid}/notes

Create note

course_createNote 1 param body → 200400

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Course (35 properties), CourseFile (15 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 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.

PersonRef

object

A reference to a person internal to the institution

1 required

FormattedLocalizedString

object

A set of localized strings that support formatting. Invalid locale values will be ignored.

CourseFile

object

A file related to a course

15 properties 2 required

ClassifiedCourseDevelopedByAssociation

object

A person who developed a given course.

4 properties 1 required

DateRange

object

A date range

2 properties

OrganizationRef

object

A reference to an organization in the institution

1 required

ClassifiedFormattedLocalizedValue

object

A classified formatted localized value

3 properties 1 required

SystemLocalizedString

object

A set of localized string values each for a specific UI locale.

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

ImageFile

object

An image file

15 properties 2 required

RemoteFile

object

Information about a remote file (Elsevier only)

6 properties 4 required

Link

object

A hyperlink describing a location on the web.

5 properties 1 required

Workflow

object

Information about workflow

2 properties 1 required

CoursesQuery

object

Create a query for courses

6 properties

LocalesList

object

List of available locales

1 property

UploadedFile

object

Information about the uploaded file

7 properties 1 required

CustomDefinedField

object

Map of CustomDefinedField values, where the key is the field identifier

1 property 1 required

Identifier

object

1 property 1 required

ConflictProblemDetails

object

Problem details for state conflict failures

7 properties

KeywordGroup

object

4 properties 2 required

WorkflowListResult

object

List of workflow steps.

1 property

ExternalOrganizationRef

object

A reference to an organization external to the institution

1 required

AbstractClassifiedCourseLecturerAssociation

object

An association between a course occurrence and a person who lectures on the course occurrence.

5 properties 2 required

Name

object

A name describing a person, made up of given- and family name

2 properties

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

CourseListResult

object

List of courses. Can contain a subset of all items along with the full count

3 properties

CustomDefinedFields

object

Map of CustomDefinedField values, where the key is the field identifier

ClassificationSchemeRef

object

A reference to a classification scheme

1 required

Course

object

A course.

35 properties 6 required

ClassificationRefList

object

List of classification references

1 property

CourseOccurrence

object

An occurrence of a given course.

9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Eindhoven University of Technology publishes across the network.

TU/e Research Portal OAI-PMH

AE Profile APIs.io

Eindhoven University of Technology activity API

AE Profile APIs.io

Eindhoven University of Technology application API

AE Profile APIs.io

Eindhoven University of Technology authorCollaboration API

AE Profile APIs.io

Eindhoven University of Technology award API

AE Profile APIs.io

Eindhoven University of Technology classificationScheme API

AE Profile APIs.io

Eindhoven University of Technology concept API

AE Profile APIs.io

Eindhoven University of Technology conferenceSeries API

AE Profile APIs.io

Eindhoven University of Technology contract API

AE Profile APIs.io

Eindhoven University of Technology dataSet API

AE Profile APIs.io

Eindhoven University of Technology education API

AE Profile APIs.io

Eindhoven University of Technology equipment API

AE Profile APIs.io

#course

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Eindhoven University of Technology course API

Metadata

Authentication & Security 1

Paths & Operations 31

Schemas 39

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Eindhoven University of Technology course API

Metadata

Authentication & Security 1

Paths & Operations 31

Schemas 39

Specification

Source

More from Eindhoven University of Technology 12

API Details

Provider

Explore more