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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Queen's University Belfast

Queen's University Belfast externalPerson API

The externalPerson API from Queen's University Belfast — 22 operation(s) for externalperson.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

27 operations 22 paths 38 schemas 1 DELETE17 GET4 POST5 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
Contact
pure-support@elsevier.com
Resource Areas
1

Authentication & Security 1

Queen's University Belfast externalPerson 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 27

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

externalPerson 27
GET
/external-persons
Lists all external persons
externalPerson_list 3 params → 200
PUT
/external-persons
Create external person
externalPerson_create body → 201400
GET
/external-persons/allowed-classified-identifier-types
A list of allowed classified identifier types
externalPerson_getAllowedClassifiedIdentifierTypes → 200
GET
/external-persons/allowed-countries
A list of allowed countries
externalPerson_getAllowedCountries → 200
GET
/external-persons/allowed-image-types
A list of allowed image types
externalPerson_getAllowedImageTypes → 200
GET
/external-persons/allowed-keyword-group-configurations
A list of keyword group configurations
externalPerson_getAllowedKeywordGroupConfigurations → 200
GET
/external-persons/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
externalPerson_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/external-persons/allowed-locales
A list of allowed locales in localized strings
externalPerson_getAllowedLocales → 200
GET
/external-persons/allowed-types
A list of allowed external person types
externalPerson_getAllowedTypes → 200
GET
/external-persons/allowed-workflow-steps
A list of allowed workflow steps
externalPerson_getAllowedWorkflowSteps → 200
GET
/external-persons/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
externalPerson_getAllowedDisciplineSchemes → 200
GET
/external-persons/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
getAllowedDisciplines 3 params → 200
POST
/external-persons/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with external persons
externalPerson_listDisciplineAssociations 1 param body → 200400
PUT
/external-persons/file-uploads
Upload file to a specific external person
externalPerson_fileUploads 1 param body → default
GET
/external-persons/orderings
Lists available orderings
externalPerson_getOrderings → 200
POST
/external-persons/search
Query operation for external persons
externalPerson_query body → 200400
GET
/external-persons/{uuid}
Get external person
externalPerson_get 1 param → 200301404
PUT
/external-persons/{uuid}
Update external persons
externalPerson_update 1 param body → 200400404409
DELETE
/external-persons/{uuid}
Delete external person
externalPerson_delete 1 param → 204404409
POST
/external-persons/{uuid}/actions/lock
Lock the content
externalPerson_lock 1 param → 204404409
POST
/external-persons/{uuid}/actions/unlock
Unlock the content
externalPerson_unlock 1 param → 204404409
GET
/external-persons/{uuid}/dependents
Lists all dependents to a external person
externalPerson_dependents 2 params → 200
GET
/external-persons/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the external person
externalPerson_getDisciplineAssociation 2 params → 200404
PUT
/external-persons/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the external person
externalPerson_putDisciplineAssociation 2 params body → 200400404
GET
/external-persons/{uuid}/files/{fileId}
Get file from the external person
externalPerson_getFile 2 params → 200
GET
/external-persons/{uuid}/notes
Lists notes
externalPerson_listNotes 3 params → 200404
PUT
/external-persons/{uuid}/notes
Create note
externalPerson_createNote 1 param body → 200400

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ExternalPerson (22 properties), ImageFile (15 properties), AllowedKeywordGroupConfiguration (10 properties), ConflictProblemDetails (7 properties). Each schema is shown below with its type and property counts.

ExternalPerson
object
A person not known to the institution
22 properties
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
UploadedFile
object
Information about the uploaded file
7 properties 1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Identifier
object
1 property 1 required
Name
object
A name describing a person, made up of given- and family name
2 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
Note
object
A note
3 properties 1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationRef
object
A reference to a classification value
2 properties 1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ExternalPersonListResult
object
List of external persons. Can contain a subset of all items along with the full count
3 properties
ContentRefListResult
object
List of Content Refs
1 property
ProblemDetails
object
RFC7807 Error details
5 properties
ContentRef
object
2 properties 2 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
ImageFile
object
An image file
15 properties 2 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
PageInformation
object
Information about pages
2 properties
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
WorkflowListResult
object
List of workflow steps.
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
KeywordGroup
object
4 properties 2 required
LocalesList
object
List of available locales
1 property
NoteListResult
object
List of notes
3 properties
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
Workflow
object
Information about workflow
2 properties 1 required
OrderingsList
object
List of available orderings
1 property
ExternalPersonsQuery
object
Create a query for external persons
6 properties
Gender
object
A list of possible genders
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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

Queen's University Belfast Research Portal (Pure OAI-PMH)
AE Profile APIs.io
Queen's University Belfast activity API
AE Profile APIs.io
Queen's University Belfast application API
AE Profile APIs.io
Queen's University Belfast authorCollaboration API
AE Profile APIs.io
Queen's University Belfast award API
AE Profile APIs.io
Queen's University Belfast classificationScheme API
AE Profile APIs.io
Queen's University Belfast concept API
AE Profile APIs.io
Queen's University Belfast conferenceSeries API
AE Profile APIs.io
Queen's University Belfast contract API
AE Profile APIs.io
Queen's University Belfast course API
AE Profile APIs.io
Queen's University Belfast dataSet API
AE Profile APIs.io
Queen's University Belfast education API
AE Profile APIs.io
#externalPerson
← Back to Q APIs
API Details
ID
queens-university-belfast:queens-university-belfast-externalperson-api
Base URL
https://pureadmin.qub.ac.uk/ws/oai
Docs
https://pure.qub.ac.uk/
Provider
Queen's University Belfast
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network