Maastricht University

Maastricht University Notifications API

The Notifications API from Maastricht University — 8 operation(s) for notifications.

GitHub OpenAPI

Documentation

📖
Documentation
https://guides.dataverse.org/en/latest/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/openapi/maastricht-notifications-api-openapi.yml

Other Resources

🔗
Website
https://dataverse.nl/dataverse/maastricht
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-schema/maastricht-dataverse-schema.json
🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-schema/maastricht-dataset-schema.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-structure/maastricht-dataverse-structure.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-structure/maastricht-dataset-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-getDataverse-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-search-example.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/examples/maastricht-version-example.json
🔗
x-spectral-rules
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/rules/maastricht-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/vocabulary/maastricht-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/maastricht/refs/heads/main/json-ld/maastricht-context.jsonld

OpenAPI Specification

maastricht-notifications-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Notifications API
  description: 'Open source research data repository software. — DataverseNL installation (v6.9) hosting the Maastricht University research data collection (alias: maastricht). Spec retrieved live from https://dataverse.nl/openapi and saved faithfully as OpenAPI 3.0.3.'
  version: '6.9'
servers:
- url: https://dataverse.nl/api
  description: DataverseNL production REST API (hosts the Maastricht University collection at /dataverse/maastricht)
tags:
- name: Notifications
paths:
  /notifications/all:
    get:
      operationId: Notifications_getAllNotificationsForUser
      parameters:
      - name: inAppNotificationFormat
        in: query
        schema:
          type: boolean
      - name: limit
        in: query
        schema:
          format: int32
          type: integer
      - name: offset
        in: query
        schema:
          format: int32
          type: integer
      - name: onlyUnread
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/mutedEmails:
    get:
      operationId: Notifications_getMutedEmailsForUser
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/mutedEmails/{typeName}:
    put:
      operationId: Notifications_muteEmailsForUser
      parameters:
      - name: typeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notifications
    delete:
      operationId: Notifications_unmuteEmailsForUser
      parameters:
      - name: typeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/mutedNotifications:
    get:
      operationId: Notifications_getMutedNotificationsForUser
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/mutedNotifications/{typeName}:
    put:
      operationId: Notifications_muteNotificationsForUser
      parameters:
      - name: typeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notifications
    delete:
      operationId: Notifications_unmuteNotificationsForUser
      parameters:
      - name: typeName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/unreadCount:
    get:
      operationId: Notifications_getUnreadNotificationsCountForUser
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/{id}:
    delete:
      operationId: Notifications_deleteNotificationForUser
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
      tags:
      - Notifications
  /notifications/{id}/markAsRead:
    put:
      operationId: Notifications_markNotificationAsReadForUser
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
      tags:
      - Notifications