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

public class dtos
{

    /**
    * Updates the order/index of the specified notification
    */
    @Api(Description="Updates the order/index of the specified notification")
    public static class SaveNotificationsOrder
    {
        /**
        * Notification Id of the item being updated.
        */
        @ApiMember(DataType="Guid", Description="Notification Id of the item being updated.", Name="NotificationId")
        public UUID NotificationId = 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")
        public Integer Index = null;
        
        public UUID getNotificationId() { return NotificationId; }
        public SaveNotificationsOrder setNotificationId(UUID value) { this.NotificationId = value; return this; }
        public Integer getIndex() { return Index; }
        public SaveNotificationsOrder setIndex(Integer value) { this.Index = value; return this; }
    }

    public static class StringResponse
    {
        public String Result = null;
        
        public String getResult() { return Result; }
        public StringResponse setResult(String value) { this.Result = value; return this; }
    }

}

Java SaveNotificationsOrder DTOs

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

HTTP + JSV

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

{
	Index: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Result: String
}