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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StringResponse:
    result: Optional[str] = None


# @Api(Description="Updates the order/index of the specified notification")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveNotificationsOrder:
    """
    Updates the order/index of the specified notification
    """

    # @ApiMember(DataType="Guid", Description="Notification Id of the item being updated.", Name="NotificationId")
    notification_id: Optional[str] = None
    """
    Notification Id of the item being updated.
    """


    # @ApiMember(DataType="int", Description="The new index of the notification. Indexes start at 1.", Name="Index")
    index: int = 0
    """
    The new index of the notification. Indexes start at 1.
    """

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