Trendsic Platform Service

<back to all web services

CoverageSwapViewRequest

The following routes are available for this service:
GET/v1/coverage/swap/{Token}
<?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 CoverageSwapSideInfo implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $DateText=null,
        /** @var string|null */
        public ?string $JobName=null,
        /** @var bool|null */
        public ?bool $Consented=null
    ) {
    }

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

class CoverageSwapViewResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $State=null,
        /** @var CoverageSwapSideInfo|null */
        public ?CoverageSwapSideInfo $You=null,
        /** @var CoverageSwapSideInfo|null */
        public ?CoverageSwapSideInfo $Them=null,
        /** @var bool|null */
        public ?bool $Directed=null,
        /** @var string|null */
        public ?string $WithdrawnBy=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['State'])) $this->State = $o['State'];
        if (isset($o['You'])) $this->You = JsonConverters::from('CoverageSwapSideInfo', $o['You']);
        if (isset($o['Them'])) $this->Them = JsonConverters::from('CoverageSwapSideInfo', $o['Them']);
        if (isset($o['Directed'])) $this->Directed = $o['Directed'];
        if (isset($o['WithdrawnBy'])) $this->WithdrawnBy = $o['WithdrawnBy'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->State)) $o['State'] = $this->State;
        if (isset($this->You)) $o['You'] = JsonConverters::to('CoverageSwapSideInfo', $this->You);
        if (isset($this->Them)) $o['Them'] = JsonConverters::to('CoverageSwapSideInfo', $this->Them);
        if (isset($this->Directed)) $o['Directed'] = $this->Directed;
        if (isset($this->WithdrawnBy)) $o['WithdrawnBy'] = $this->WithdrawnBy;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /v1/coverage/swap/{Token} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	State: String,
	You: 
	{
		Name: String,
		DateText: String,
		JobName: String,
		Consented: False
	},
	Them: 
	{
		Name: String,
		DateText: String,
		JobName: String,
		Consented: False
	},
	Directed: False,
	WithdrawnBy: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}