How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Manchester External Person API

The externalPerson API from University of Manchester — 22 operation(s) for externalperson.

University of Manchester External Person API is one of 41 APIs that University of Manchester publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 22 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 5.35.2-2.

Requests are made against a single base URL, /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.2.0
API Version
5.35.2-2
Base URL
http://mdq.ukfederation.org.uk/entities/https%3A%2F%2Fshib.manchester.ac.uk%2Fshibboleth
Authentication
API Key
Resource Areas
1

Authentication & Security 1

University of Manchester External Person 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…
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), UploadedFile (7 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-manchester-externalperson-api-openapi.yml Raw ↑

Other APIs University of Manchester publishes across the network.

Shibboleth SAML Identity Provider (UK Access Management Federation)
Elsevier Pure CRIS tenancy (REST + OAI-PMH)
Figshare research data repository tenancy
University of Manchester Image API
University of Manchester Presentation API
University of Manchester Activity API
University of Manchester Application API
University of Manchester Author Collaboration API
University of Manchester Award API
University of Manchester Classification Scheme API
University of Manchester Concept API
University of Manchester Contract API
Where this information came from

This is an independent, third-party profile of University of Manchester External Person API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.