Trendsic Platform Service

<back to all web services

CoverageSelfSwapCheckRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/swapcheck
<?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 CoverageSelfCheckRow implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Label=null,
        /** @var bool|null */
        public ?bool $Ok=null
    ) {
    }

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

class CoverageSelfSwapCheckResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<CoverageSelfCheckRow>|null */
        public ?array $Checks=null,
        /** @var bool|null */
        public ?bool $Ok=null
    ) {
    }

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

class CoverageSelfSwapCheckRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AItemId=0,
        /** @var int */
        public int $BItemId=0,
        /** @var int */
        public int $TargetContactID=0,
        /** @var bool|null */
        public ?bool $Broadcast=null
    ) {
    }

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

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

GET /v1/coverage/self/swapcheck HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageSelfSwapCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Checks>
    <CoverageSelfCheckRow>
      <Label>String</Label>
      <Ok>false</Ok>
    </CoverageSelfCheckRow>
  </Checks>
  <Ok>false</Ok>
  <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>
</CoverageSelfSwapCheckResponse>