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

Aarhus University studentProject API

The studentProject API from Aarhus University — 26 operation(s) for studentproject.

Aarhus University studentProject API is one of 39 APIs that Aarhus University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include studentProject. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

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

Requests are made against a single base URL, https://pure.au.dk/ws/api.

30 operations 26 paths 44 schemas 1 DELETE22 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.au.dk/ws
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Aarhus University studentProject 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 30

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

studentProject 30
GET
/student-projects
Lists all student projects
studentProject_list 3 params → 200
PUT
/student-projects
Create student project
studentProject_create body → 201400
GET
/student-projects/allowed-appendix-document-licenses
A list of allowed document licenses
studentProject_getAllowedAppendixDocumentLicenses → 200
GET
/student-projects/allowed-appendix-document-types
A list of allowed document types
studentProject_getAllowedAppendixDocumentTypes → 200
GET
/student-projects/allowed-campuses
A list of allowed campuses
studentProject_getAllowedCampuses → 200
GET
/student-projects/allowed-document-licenses
A list of allowed document licenses
studentProject_getAllowedDocumentLicenses → 200
GET
/student-projects/allowed-document-types
A list of allowed document types
studentProject_getAllowedDocumentTypes → 200
GET
/student-projects/allowed-external-collaborator-roles
A list of allowed external collaborator rules
studentProject_getAllowedExternalCollaboratorRoles → 200
GET
/student-projects/allowed-groups
A list of allowed groups
studentProject_getAllowedGroups → 200
GET
/student-projects/allowed-image-types
A list of allowed image types
studentProject_getAllowedImageTypes → 200
GET
/student-projects/allowed-keyword-group-configurations
A list of keyword group configurations
studentProject_getAllowedKeywordGroupConfigurations → 200
GET
/student-projects/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
studentProject_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/student-projects/allowed-languages
A list of allowed languages
studentProject_getAllowedLanguages → 200
GET
/student-projects/allowed-link-types
A list of allowed link types
studentProject_getAllowedLinkTypes → 200
GET
/student-projects/allowed-locales
A list of allowed locales in localized strings
studentProject_getAllowedLocales → 200
GET
/student-projects/allowed-supervisor-types
A list of allowed supervisor types
studentProject_getAllowedSupervisorTypes → 200
GET
/student-projects/allowed-types
A list of allowed student project types
studentProject_getAllowedTypes → 200
GET
/student-projects/allowed-workflow-steps
A list of allowed workflow steps in localized strings
studentProject_getAllowedWorkflowSteps → 200
PUT
/student-projects/file-uploads
Upload file to a specific student project
studentProject_fileUploads 1 param body → default
GET
/student-projects/orderings
Lists available orderings
studentProject_getOrderings → 200
POST
/student-projects/search
Query operation for student project
studentProject_query body → 200400
GET
/student-projects/{uuid}
Get student project
studentProject_get 1 param → 200301404
PUT
/student-projects/{uuid}
Update student project
studentProject_update 1 param body → 200400404409
DELETE
/student-projects/{uuid}
Delete student project
studentProject_delete 1 param → 204404409
POST
/student-projects/{uuid}/actions/lock
Lock the content
studentProject_lock 1 param → 204404409
POST
/student-projects/{uuid}/actions/unlock
Unlock the content
studentProject_unlock 1 param → 204404409
GET
/student-projects/{uuid}/dependents
Lists all dependents to the student project
studentProject_dependents 2 params → 200
GET
/student-projects/{uuid}/files/{fileId}
Get file from the student project
studentProject_getFile 2 params → 200
GET
/student-projects/{uuid}/notes
Lists notes
studentProject_listNotes 3 params → 200404
PUT
/student-projects/{uuid}/notes
Create note
studentProject_createNote 1 param body → 200400

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are StudentProject (44 properties), StudentProjectDocument (18 properties), StudentProjectAppendixDocument (17 properties), ImageFile (15 properties). Each schema is shown below with its type and property counts.

ExternalPersonRef
object
A reference to a person external to the institution
1 required
Note
object
A note
3 properties 1 required
SpecializationRef
object
A reference to a specialization
1 required
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
StudentProjectSupervisor
object
A supervisor for a student project
5 properties 2 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRef
object
A reference to a classification value
2 properties 1 required
ClassificationRefList
object
List of classification references
1 property
KeywordGroup
object
4 properties 2 required
NoteListResult
object
List of notes
3 properties
OrganizationRef
object
A reference to an organization in the institution
1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ContentRef
object
2 properties 2 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ImageFile
object
An image file
15 properties 2 required
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
EducationAssociation
object
An association to an education
4 properties 2 required
PageInformation
object
Information about pages
2 properties
StudentProjectAppendixDocument
object
A student project appendix document
17 properties 4 required
StudentProjectDocument
object
A student project document
18 properties 4 required
StudentProjectExternalCollaborator
object
An external collaborator of a student project
6 properties 4 required
LocalesList
object
List of available locales
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
SemesterRef
object
A reference to semester
1 required
Visibility
object
Visibility of an object
2 properties 1 required
OrderingsList
object
List of available orderings
1 property
StudentProjectListResult
object
List of student projects. Can contain a subset of all items along with the full count
3 properties
CompoundDate
object
A date that can be defined by only year, year and month or a full date
3 properties 1 required
ProblemDetails
object
RFC7807 Error details
5 properties
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
EducationRef
object
A reference to Education
1 required
StudentProjectQuery
object
Create a query for studentProject
6 properties
StudentProjectAuthor
object
The collection of authors of the student project
4 properties 2 required
StudentProjectNotificationRecipient
object
A number of email addresses that will be notified once this student project enters the validated workflow step
2 properties 1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
PersonRef
object
A reference to a person internal to the institution
1 required
StudentProject
object
A student project
44 properties 10 required
WorkflowListResult
object
List of workflow steps.
1 property
Workflow
object
Information about workflow
2 properties 1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
ContentRefListResult
object
List of Content Refs
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aarhus-studentproject-api-openapi.yml Raw ↑

Other APIs Aarhus University publishes across the network.

Pure OAI-PMH Metadata Service
Course Catalogue and Timetable (mitstudie / STADS)
Aarhus University activity API
Aarhus University application API
Aarhus University authorCollaboration API
Aarhus University award API
Aarhus University classificationScheme API
Aarhus University concept API
Aarhus University conferenceSeries API
Aarhus University contract API
Aarhus University course API
Aarhus University dataSet API