Queen's University at Kingston

Queen's University at Kingston Notifications API

The Notifications API from Queen's University at Kingston — 8 operation(s) for notifications.

GitHub OpenAPI

Documentation

📖
Documentation
https://borealisdata.ca/guides/en/latest/api/native-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/queens-university-at-kingston/refs/heads/main/openapi/queens-university-at-kingston-notifications-api-openapi.yml

Other Resources

🔗
OAI-PMH
https://borealisdata.ca/oai?verb=Identify

OpenAPI Specification

queens-university-at-kingston-notifications-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Notifications API
  description: Open source research data repository software.
  version: v6.8.1-SP
servers:
- url: https://borealisdata.ca/api
  description: Borealis (Canadian Dataverse Repository) hosting the Queen University Dataverse
tags:
- name: Notifications
paths:
  /notifications/all:
    get:
      operationId: Notifications_getAllNotificationsForUser
      parameters:
      - name: inAppNotificationFormat
        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