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 role API

The role API from Queen's University Belfast — 2 operation(s) for role.

Queen’s University Belfast role 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 role. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

2 operations 2 paths 2 schemas 2 GET

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 role 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

role 2
GET
/roles
Lists all assignable roles
role_get_assignable_roles → 200
GET
/roles/{assignableRoleName}
Returns an assignable role
role_get_assignable_role 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is AssignableRole (3 properties). Each schema is shown below with its type and property counts.

AssignableRole
object
An assignable role
3 properties 1 required
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-role-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