Platform API

<back to all web services

SaveNotificationsOrder

Updates the order/index of the specified notification

Requires Authentication
The following routes are available for this service:
PUT/api/notification/{NotificationId}/index/{Index}
"use strict";
export class StringResponse {
    /** @param {{Result?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Result;
}
export class SaveNotificationsOrder {
    /** @param {{NotificationId?:string,Index?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Notification Id of the item being updated. */
    NotificationId;
    /**
     * @type {number}
     * @description The new index of the notification. Indexes start at 1. */
    Index;
}

JavaScript SaveNotificationsOrder DTOs

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

HTTP + CSV

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

PUT /api/notification/{NotificationId}/index/{Index} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"NotificationId":"00000000-0000-0000-0000-000000000000","Index":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":"String"}