Trendsic Platform Service

CustomerNotificationsSaveRequest

The following routes are available for this service:
PUT	/v1/c/notifications

<?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 NotificationPrefView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Key=null,
        /** @var string|null */
        public ?string $Label=null,
        /** @var string|null */
        public ?string $Sub=null,
        /** @var bool|null */
        public ?bool $IsOn=null
    ) {
    }

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

class CustomerNotificationsResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Audience=null,
        /** @var array<NotificationPrefView>|null */
        public ?array $Items=null,
        /** @var int */
        public int $Devices=0,
        /** @var bool|null */
        public ?bool $PushConfigured=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Audience'])) $this->Audience = $o['Audience'];
        if (isset($o['Items'])) $this->Items = JsonConverters::fromArray('NotificationPrefView', $o['Items']);
        if (isset($o['Devices'])) $this->Devices = $o['Devices'];
        if (isset($o['PushConfigured'])) $this->PushConfigured = $o['PushConfigured'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Audience)) $o['Audience'] = $this->Audience;
        if (isset($this->Items)) $o['Items'] = JsonConverters::toArray('NotificationPrefView', $this->Items);
        if (isset($this->Devices)) $o['Devices'] = $this->Devices;
        if (isset($this->PushConfigured)) $o['PushConfigured'] = $this->PushConfigured;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class NotificationPrefInput implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Key=null,
        /** @var bool|null */
        public ?bool $IsOn=null
    ) {
    }

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

class CustomerNotificationsSaveRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Audience=null,
        /** @var array<NotificationPrefInput>|null */
        public ?array $Items=null
    ) {
    }

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

PHP CustomerNotificationsSaveRequest 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 /v1/c/notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerNotificationsSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Audience>String</Audience>
  <Items>
    <NotificationPrefInput>
      <IsOn>false</IsOn>
      <Key>String</Key>
    </NotificationPrefInput>
  </Items>
</CustomerNotificationsSaveRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Audience>String</Audience>
  <Devices>0</Devices>
  <Items>
    <NotificationPrefView>
      <IsOn>false</IsOn>
      <Key>String</Key>
      <Label>String</Label>
      <Sub>String</Sub>
    </NotificationPrefView>
  </Items>
  <PushConfigured>false</PushConfigured>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomerNotificationsResponse>