regis

<back to all web services

NotificationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Notifications/{uuid}
"use strict";
export class NotificationsRequest {
    /** @param {{uuid?:string,all_notifications?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {boolean} */
    all_notifications;
}

JavaScript NotificationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Notifications/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NotificationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <all_notifications>false</all_notifications>
  <uuid>String</uuid>
</NotificationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfNotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <NotificationResponse>
    <description>String</description>
    <read_date>0001-01-01T00:00:00</read_date>
    <regarding_uuid>String</regarding_uuid>
    <sent_date>0001-01-01T00:00:00</sent_date>
    <title>String</title>
    <uuid>String</uuid>
  </NotificationResponse>
</ArrayOfNotificationResponse>