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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * 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")
    open var Index:Int? = null
}

open class StringResponse
{
    open var Result:String? = null
}

Kotlin SaveNotificationsOrder DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

{"Result":"String"}