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

Newcastle University Entity API

An entity ordinarily describes a spatial location, such as a room in a building, or a pole in the street. In some circumstances, an entity may be a mobile piece of equipment, such as those used for validation, in which case the location will be provided as a timeseries.

Newcastle University Entity API is one of 8 APIs that Newcastle University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Entity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 2.0a.

Requests are made against a single base URL, https://api.usb.urbanobservatory.ac.uk/api/v2.0a.

2 operations 2 paths 12 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0a
Base URL
https://api.usb.urbanobservatory.ac.uk/api/v2.0a
Contact
Resource Areas
1

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.

Entity 2

An entity ordinarily describes a spatial location, such as a room in a building, or a pole in the street. In some circumstances, an entity may be a mobile piece of equipment, such…

GET
/api/v2.0a/sensors/entity
List all entities (paginated)
EntityController.getAll 5 params → 200
GET
/api/v2.0a/sensors/entity/{id}
Request a single entity by its unique ID
EntityController.getOne 1 param → 200400

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Feed (8 properties), Timeseries (8 properties), TimeseriesEntry (6 properties), Entity (5 properties). Each schema is shown below with its type and property counts.

TimeseriesEntry
object
A historic entry associated with a timeseries and a time.
6 properties
Feed
object
8 properties
Licence
object
4 properties
Organisation
object
An organisation which is providing the data to the Urban Observatory, or responsible for some element.
4 properties
Link
object
A link provided for [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) purposes, to the item itself or an associated API method.
3 properties
Unit
object
The units associated with the values held in the timeseries.
2 properties
Entity
object
5 properties
BadRequest
object
An invalid ID or query parameter was used to request information, such as an ID not in the [UUID syntax](https://en.wikipedia.org/wiki/Universallyuniqueidentif…
3 properties
Pagination
object
The pagination associated with the response, and data concerning the total number of items and pages.
4 properties
Contact
object
The contact for more information, or technical issues relating to the sensing. This may not always be available.
4 properties
Timeseries
object
8 properties
Storage
object
The storage mechanism used to hold the data internally.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newcastle-entity-api-openapi.yml Raw ↑

Other APIs Newcastle University publishes across the network.

Digitised Objects Repository Search and Data API
ECPPEC Electoral Data API
data.ncl Research Data Repository (Figshare)
EPrints Institutional Repository (OAI-PMH)
Newcastle University Feed API
Newcastle University Summary API
Newcastle University Timeseries API