Trendsic Platform Service

<back to all web services

DispatchNoticeAckRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/notice/{Token}/ack
<?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 DispatchNoticeResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $RefCode=null,
        /** @var string|null */
        public ?string $RecipientName=null,
        /** @var string|null */
        public ?string $Headline=null,
        /** @var string|null */
        public ?string $Body=null,
        /** @var string|null */
        public ?string $AffectedText=null,
        /** @var string|null */
        public ?string $OriginalWindow=null,
        /** @var string|null */
        public ?string $NewWindow=null,
        /** @var string|null */
        public ?string $ScopeLabel=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var string|null */
        public ?string $HoldStatus=null,
        /** @var DateTime|null */
        public ?DateTime $ResumesUtc=null,
        /** @var bool|null */
        public ?bool $Acked=null,
        /** @var bool|null */
        public ?bool $Invalid=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RefCode'])) $this->RefCode = $o['RefCode'];
        if (isset($o['RecipientName'])) $this->RecipientName = $o['RecipientName'];
        if (isset($o['Headline'])) $this->Headline = $o['Headline'];
        if (isset($o['Body'])) $this->Body = $o['Body'];
        if (isset($o['AffectedText'])) $this->AffectedText = $o['AffectedText'];
        if (isset($o['OriginalWindow'])) $this->OriginalWindow = $o['OriginalWindow'];
        if (isset($o['NewWindow'])) $this->NewWindow = $o['NewWindow'];
        if (isset($o['ScopeLabel'])) $this->ScopeLabel = $o['ScopeLabel'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['HoldStatus'])) $this->HoldStatus = $o['HoldStatus'];
        if (isset($o['ResumesUtc'])) $this->ResumesUtc = JsonConverters::from('DateTime', $o['ResumesUtc']);
        if (isset($o['Acked'])) $this->Acked = $o['Acked'];
        if (isset($o['Invalid'])) $this->Invalid = $o['Invalid'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RefCode)) $o['RefCode'] = $this->RefCode;
        if (isset($this->RecipientName)) $o['RecipientName'] = $this->RecipientName;
        if (isset($this->Headline)) $o['Headline'] = $this->Headline;
        if (isset($this->Body)) $o['Body'] = $this->Body;
        if (isset($this->AffectedText)) $o['AffectedText'] = $this->AffectedText;
        if (isset($this->OriginalWindow)) $o['OriginalWindow'] = $this->OriginalWindow;
        if (isset($this->NewWindow)) $o['NewWindow'] = $this->NewWindow;
        if (isset($this->ScopeLabel)) $o['ScopeLabel'] = $this->ScopeLabel;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->HoldStatus)) $o['HoldStatus'] = $this->HoldStatus;
        if (isset($this->ResumesUtc)) $o['ResumesUtc'] = JsonConverters::to('DateTime', $this->ResumesUtc);
        if (isset($this->Acked)) $o['Acked'] = $this->Acked;
        if (isset($this->Invalid)) $o['Invalid'] = $this->Invalid;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

PHP DispatchNoticeAckRequest 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 /v1/dispatch/notice/{Token}/ack HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Token: String
}

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

{
	RefCode: String,
	RecipientName: String,
	Headline: String,
	Body: String,
	AffectedText: String,
	OriginalWindow: String,
	NewWindow: String,
	ScopeLabel: String,
	Reason: String,
	HoldStatus: String,
	ResumesUtc: 0001-01-01,
	Acked: False,
	Invalid: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}