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 UserNotificationOptOut API

Endpoints for the user notification opt outs.

RWTH Aachen University UserNotificationOptOut 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 UserNotificationOptOut. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 5 operations across 3 paths, 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.

5 operations 3 paths 5 schemas 1 DELETE2 GET1 OPTIONS1 POST

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 UserNotificationOptOut 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 5

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

UserNotificationOptOut 5

Endpoints for the user notification opt outs.

GET
/api/v2/user-notifications/{notificationId}
Retrieves a user notification opt out for a specified notification.
GetUserNotification 1 param → 200404
GET
/api/v2/user-notifications
Retrieves all user notification opt outs of the current user.
GetUserNotifications 3 params → 200403
POST
/api/v2/user-notifications
Creates a user notification opt out for a specified user.
CreateUserNotification body → 201400404
OPTIONS
/api/v2/user-notifications
Responds with the HTTP methods allowed for the endpoint.
→ 200
DELETE
/api/v2/user-notifications/{id}
Deletes a user notification opt out for a specified user.
DeleteUserNotification 1 param → 204403404

Schemas 5

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

UserNotificationOptOutDtoPagedResponse
object
5 properties
UserNotificationForCreationDto
object
Data transfer object (DTO) representing the creation of a user notification.
1 property 1 required
Pagination
object
Represents pagination information for a collection of items.
6 properties
UserNotificationOptOutDto
object
Represents a minimal data transfer object (DTO) for a user notification.
3 properties 3 required
UserNotificationOptOutDtoResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rwth-aachen-university-usernotificationoptout-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