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

Queen's University Belfast semester API

The semester API from Queen's University Belfast — 8 operation(s) for semester.

Queen’s University Belfast semester API is one of 38 APIs that Queen’s University Belfast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 11 operations across 8 paths, and defines 13 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.qub.ac.uk/ws/api.

11 operations 8 paths 13 schemas 1 DELETE5 GET3 POST2 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://pureadmin.qub.ac.uk/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Queen's University Belfast semester 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 11

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

semester 11
GET
/semesters
Lists all semesters
semester_list 3 params → 200
PUT
/semesters
Create semester
semester_create body → 201400409
GET
/semesters/allowed-locales
A list of allowed locales in localized strings
semester_getAllowedLocales → 200
GET
/semesters/orderings
Lists available orderings
semester_getOrderings → 200
POST
/semesters/search
Query operation for semester
semester_query body → 200400
GET
/semesters/{uuid}
Get semester
semester_get 1 param → 200301404
PUT
/semesters/{uuid}
Update semester
semester_update 1 param body → 200400404
DELETE
/semesters/{uuid}
Delete semester
semester_delete 1 param → 204404409
POST
/semesters/{uuid}/actions/lock
Lock the content
semester_lock 1 param → 204404409
POST
/semesters/{uuid}/actions/unlock
Unlock the content
semester_unlock 1 param → 204404409
GET
/semesters/{uuid}/dependents
Lists all dependents to the semester
semester_dependents 2 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Semester (16 properties), ConflictProblemDetails (7 properties), SemesterQuery (6 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

Identifier
object
1 property 1 required
Semester
object
A semester
16 properties 2 required
LocalesList
object
List of available locales
1 property
EducationRef
object
A reference to Education
1 required
PageInformation
object
Information about pages
2 properties
SemesterListResult
object
List of semesters. Can contain a subset of all items along with the full count
3 properties
SemesterQuery
object
Create a query for semester
6 properties
OrderingsList
object
List of available orderings
1 property
ContentRefListResult
object
List of Content Refs
1 property
ProblemDetails
object
RFC7807 Error details
5 properties
ContentRef
object
2 properties 2 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

queens-university-belfast-semester-api-openapi.yml Raw ↑

Other APIs Queen's University Belfast publishes across the network.

Queen's University Belfast Research Portal (Pure OAI-PMH)
Queen's University Belfast activity API
Queen's University Belfast application API
Queen's University Belfast authorCollaboration API
Queen's University Belfast award API
Queen's University Belfast classificationScheme API
Queen's University Belfast concept API
Queen's University Belfast conferenceSeries API
Queen's University Belfast contract API
Queen's University Belfast course API
Queen's University Belfast dataSet API
Queen's University Belfast education API