Support.WebApi

<back to all web services

SendNotification

The following routes are available for this service:
POST/support/notification/send
<?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 SendNotification implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $senderId=null,
        /** @var string|null */
        public ?string $displayName=null,
        /** @var string|null */
        public ?string $destination=null,
        /** @var array<string,Object>|null */
        public ?array $payload=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['senderId'])) $this->senderId = $o['senderId'];
        if (isset($o['displayName'])) $this->displayName = $o['displayName'];
        if (isset($o['destination'])) $this->destination = $o['destination'];
        if (isset($o['payload'])) $this->payload = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $o['payload']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->senderId)) $o['senderId'] = $this->senderId;
        if (isset($this->displayName)) $o['displayName'] = $this->displayName;
        if (isset($this->destination)) $o['destination'] = $this->destination;
        if (isset($this->payload)) $o['payload'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','Object']), $this->payload);
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /support/notification/send HTTP/1.1 
Host: support.bettor-dual-stage.webhop.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Support.WebApi.ServiceModel">
  <Destination>String</Destination>
  <DisplayName>String</DisplayName>
  <Payload xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Payload>
  <SenderId>String</SenderId>
</SendNotification>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>