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}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type StringResponse() = 
        member val Result:String = null with get,set

    ///<summary>
    ///Updates the order/index of the specified notification
    ///</summary>
    [<Api(Description="Updates the order/index of the specified notification")>]
    [<AllowNullLiteral>]
    type SaveNotificationsOrder() = 
        ///<summary>
        ///Notification Id of the item being updated.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Notification Id of the item being updated.", Name="NotificationId")>]
        member val NotificationId:Guid = new Guid() with get,set

        ///<summary>
        ///The new index of the notification. Indexes start at 1.
        ///</summary>
        [<ApiMember(DataType="int", Description="The new index of the notification. Indexes start at 1.", Name="Index")>]
        member val Index:Int32 = new Int32() with get,set

F# SaveNotificationsOrder DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"Result":"String"}