Platform API

SaveNotificationsOrder

Updates the order/index of the specified notification

The following routes are available for this service:
PUT	/api/notification/{NotificationId}/index/{Index}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class StringResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Result=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Result'])) $this->Result = $o['Result'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Result)) $o['Result'] = $this->Result;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Updates the order/index of the specified notification */
// @Api(Description="Updates the order/index of the specified notification")
class SaveNotificationsOrder implements JsonSerializable
{
    public function __construct(
        /** @description Notification Id of the item being updated. */
        // @ApiMember(DataType="Guid", Description="Notification Id of the item being updated.", Name="NotificationId")
        /** @var string */
        public string $NotificationId='',

        /** @description 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")
        /** @var int */
        public int $Index=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['NotificationId'])) $this->NotificationId = $o['NotificationId'];
        if (isset($o['Index'])) $this->Index = $o['Index'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->NotificationId)) $o['NotificationId'] = $this->NotificationId;
        if (isset($this->Index)) $o['Index'] = $this->Index;
        return empty($o) ? new class(){} : $o;
    }
}

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