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

Yale University Facets API

Faceted aggregation over search results

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

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

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://lux.collections.yale.edu.

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://gw.its.yale.edu/soa-gateway/courses/webservice/v3/index
License
Resource Areas
1

Paths & Operations 1

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

Facets 1

Faceted aggregation over search results

GET
/api/facets/{scope}
Retrieve facet values
facets 5 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OrderedCollection (8 properties), OrderedCollectionPage (7 properties), CollectionPageRef (2 properties), EntityRef (2 properties). Each schema is shown below with its type and property counts.

OrderedCollection
object
A Linked Art OrderedCollection summarizing a result set.
8 properties 3 required
EntityRef
object
A reference to a LUX entity returned within search results.
2 properties 2 required
OrderedCollectionPage
object
A single page of a Linked Art OrderedCollection.
7 properties 3 required
LanguageMap
object
A Linked Art language map: keys are language tags and values are arrays of strings.
CollectionPageRef
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yale-facets-api-openapi.yml Raw ↑

Other APIs Yale University publishes across the network.

Courses Web Service v3
Yale API Portal (Enterprise & Portal APIs)
Yale Digital Collections IIIF
Yale University Configuration API
Yale University Documents API
Yale University Related API
Yale University Search API