Platform API

SaveNotificationsOrder

Updates the order/index of the specified notification

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 .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.

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

<SaveNotificationsOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Index>0</Index>
  <NotificationId>00000000-0000-0000-0000-000000000000</NotificationId>
</SaveNotificationsOrder>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StringResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
  <Result>String</Result>
</StringResponse>