Support.WebApi

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

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

{
	senderId: String,
	displayName: String,
	destination: String,
	payload: 
	{
		String: {}
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}