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}
import Foundation
import ServiceStack

/**
* Updates the order/index of the specified notification
*/
// @Api(Description="Updates the order/index of the specified notification")
public class SaveNotificationsOrder : Codable
{
    /**
    * Notification Id of the item being updated.
    */
    // @ApiMember(DataType="Guid", Description="Notification Id of the item being updated.", Name="NotificationId")
    public var notificationId:String

    /**
    * The new index of the notification. Indexes start at 1.
    */
    // @ApiMember(DataType="int", Description="The new index of the notification. Indexes start at 1.", Name="Index")
    public var index:Int

    required public init(){}
}

public class StringResponse : Codable
{
    public var result:String

    required public init(){}
}


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