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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Causal.Common.Entity

Namespace Global

    Namespace Eros.Causal.Common.Entity

        Public Partial Class StringResponse
            Public Overridable Property Result As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Updates the order/index of the specified notification
        '''</Summary>
        <Api(Description:="Updates the order/index of the specified notification")>
        Public Partial Class SaveNotificationsOrder
            '''<Summary>
            '''Notification Id of the item being updated.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Notification Id of the item being updated.", Name:="NotificationId")>
            Public Overridable Property NotificationId As Guid

            '''<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")>
            Public Overridable Property Index As Integer
        End Class
    End Namespace
End Namespace

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