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

King's College London collections API

The collections API from King's College London — 21 operation(s) for collections.

King’s College London collections API is one of 11 APIs that King’s College London publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 34 operations across 21 paths, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.figshare.com/v2.

34 operations 21 paths 32 schemas 5 DELETE12 GET1 PATCH11 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://kclpure.kcl.ac.uk/ws/oai
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

King's College London collections API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 34

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

collections 34
GET
/collections
Public Collections
collections_list 14 params → 200400422500
POST
/collections/search
Public Collections Search
collections_search 1 param body → 200400422500
GET
/collections/{collection_id}
Collection details
collection_details 1 param → 200400404500
GET
/collections/{collection_id}/versions
Collection Versions list
collection_versions 1 param → 200400404500
GET
/collections/{collection_id}/versions/{version_id}
Collection Version details
collection_version_details 2 params → 200400404500
GET
/collections/{collection_id}/articles
Public Collection Articles
collection_articles 5 params → 200400404422500
GET
/account/collections
Private Collections List
private_collections_list 6 params → 200400403500
POST
/account/collections
Create collection
private_collection_create body → 201400403500
GET
/account/collections/{collection_id}
Collection details
private_collection_details 1 param → 200400404500
PUT
/account/collections/{collection_id}
Update collection
private_collection_update 1 param body → 205400403404500
DELETE
/account/collections/{collection_id}
Delete collection
private_collection_delete 1 param → 204400403404500
PATCH
/account/collections/{collection_id}
Partially update collection
private_collection_patch 1 param body → 205400403404500
POST
/account/collections/search
Private Collections Search
private_collections_search body → 200400403500
POST
/account/collections/{collection_id}/reserve_doi
Private Collection Reserve DOI
private_collection_reserve_doi 1 param → 200400403500
POST
/account/collections/{collection_id}/reserve_handle
Private Collection Reserve Handle
private_collection_reserve_handle 1 param → 200400403500
POST
/account/collections/{collection_id}/resource
Private Collection Resource
private_collection_resource 1 param body → 205403404422
POST
/account/collections/{collection_id}/publish
Private Collection Publish
private_collection_publish 1 param → 201400403500
GET
/account/collections/{collection_id}/authors
List collection authors
private_collection_authors_list 1 param → 200400403404500
PUT
/account/collections/{collection_id}/authors
Replace collection authors
private_collection_authors_replace 1 param body → 205400403404500
POST
/account/collections/{collection_id}/authors
Add collection authors
private_collection_authors_add 1 param body → 201400403404500
DELETE
/account/collections/{collection_id}/authors/{author_id}
Delete collection author
private_collection_author_delete 2 params → 204403404500
GET
/account/collections/{collection_id}/categories
List collection categories
private_collection_categories_list 1 param → 200400403404500
PUT
/account/collections/{collection_id}/categories
Replace collection categories
private_collection_categories_replace 1 param body → 205400403404500
POST
/account/collections/{collection_id}/categories
Add collection categories
private_collection_categories_add 1 param body → 201400403404500
DELETE
/account/collections/{collection_id}/categories/{category_id}
Delete collection category
private_collection_category_delete 2 params → 204403404500
GET
/account/collections/{collection_id}/articles
List collection articles
private_collection_articles_list 5 params → 200400403404500
PUT
/account/collections/{collection_id}/articles
Replace collection articles
private_collection_articles_replace 1 param body → 205400403404500
POST
/account/collections/{collection_id}/articles
Add collection articles
private_collection_articles_add 1 param body → 201400403404500
DELETE
/account/collections/{collection_id}/articles/{article_id}
Delete collection article
private_collection_article_delete 2 params → 204403404500
GET
/account/collections/{collection_id}/private_links
List collection private links
private_collection_private_links_list 1 param → 200400403404500
POST
/account/collections/{collection_id}/private_links
Create collection private link
private_collection_private_link_create 1 param body → 201400403404500
GET
/account/collections/{collection_id}/private_links/{link_id}
View collection private link
private_collection_private_link_details 2 params → 200400403404500
PUT
/account/collections/{collection_id}/private_links/{link_id}
Update collection private link
private_collection_private_link_update 2 params body → 205400403404422500
DELETE
/account/collections/{collection_id}/private_links/{link_id}
Disable private link
private_collection_private_link_delete 2 params → 204400403404500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CollectionCompletePrivate (24 properties), CollectionCreate (23 properties), CollectionComplete (23 properties), CollectionUpdate (23 properties). Each schema is shown below with its type and property counts.

CommonSearch
object
10 properties
CustomArticleFieldAdd
object
2 properties 2 required
Resource
object
6 properties
CollectionVersions
object
3 properties 3 required
PrivateCollectionSearch
object
1 property
CollectionSearch
object
4 properties
LocationWarnings
object
3 properties 3 required
CollectionCreate
object
23 properties 1 required
ErrorMessage
object
2 properties
PrivateLink
object
4 properties 4 required
CollectionUpdate
object
23 properties
Location
object
1 property 1 required
TimelineUpdate
object
3 properties
Author
object
7 properties 7 required
CollectionDOI
object
1 property 1 required
PrivateLinkResponse
object
3 properties 3 required
ArticlesCreator
object
1 property 1 required
CollectionPrivateLinkCreator
object
1 property
LocationWarningsUpdate
object
2 properties 2 required
Category
object
6 properties 6 required
Article
object
16 properties 16 required
CollectionCompletePrivate
object
24 properties 23 required
CollectionHandle
object
1 property 1 required
RelatedMaterial
object
7 properties
Collection
object
6 properties 6 required
CategoriesCreator
object
1 property 1 required
CustomArticleField
object
6 properties 6 required
Timeline
AuthorsCreator
object
1 property 1 required
FundingCreate
object
2 properties
CollectionComplete
object
23 properties 23 required
FundingInformation
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kings-college-london-collections-api-openapi.yml Raw ↑

Other APIs King's College London publishes across the network.

King's Research Portal (Pure) OAI-PMH
King's College London altmetric API
King's College London articles API
King's College London authors API
King's College London institutions API
King's College London oauth API
King's College London other API
King's College London profiles API
King's College London projects API
King's College London symplectic API