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

RWTH Aachen University Search API

Endpoints for search.

RWTH Aachen University Search API is one of 49 APIs that RWTH Aachen University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://coscine.rwth-aachen.de/coscine.

2 operations 1 paths 5 schemas 1 GET1 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://coscine.rwth-aachen.de/coscine/api/
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

RWTH Aachen University Search API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme.

Paths & Operations 2

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

Search 2

Endpoints for search.

GET
/api/v2/search
Retrieves a search result by given search parameters.
GetSearchResults 7 params → 200403400404
OPTIONS
/api/v2/search
Responds with the HTTP methods allowed for the endpoint.
→ 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Pagination (6 properties), SearchResultDtoPagedSearchResponse (6 properties), SearchResultDto (3 properties), SearchCategory (2 properties). Each schema is shown below with its type and property counts.

SearchResultDtoPagedSearchResponse
object
6 properties
SearchCategory
object
Represents a search category with a name and count of occurrences.
2 properties
Pagination
object
Represents pagination information for a collection of items.
6 properties
SearchCategoryType
string
Specifies the search item type.
SearchResultDto
object
Represents a Data Transfer Object (DTO) for search results.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-search-api-openapi.yml Raw ↑

Other APIs RWTH Aachen University publishes across the network.

RWTH Publications OAI-PMH
RWTH Single Sign-On (OAuth2 / OpenID Connect / Shibboleth)
RWTH Aachen University Admin API
RWTH Aachen University ApplicationProfile API
RWTH Aachen University Blob API
RWTH Aachen University DataHamsterReport API
RWTH Aachen University Discipline API
RWTH Aachen University Graph API
RWTH Aachen University GraphMetadata API
RWTH Aachen University GraphMetadataContent API
RWTH Aachen University Handle API
RWTH Aachen University Language API