Trendsic Platform Service

<back to all web services

DispatchHeartbeatRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/heartbeat
<?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 DispatchHeartbeatTenantResult implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $TenantId='',
        /** @var int */
        public int $Tickets=0,
        /** @var int */
        public int $Releases=0,
        /** @var int */
        public int $PingsCascaded=0,
        /** @var int */
        public int $OffersExpired=0,
        /** @var string|null */
        public ?string $Error=null
    ) {
    }

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

class DispatchHeartbeatResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Tenants=0,
        /** @var int */
        public int $Tickets=0,
        /** @var int */
        public int $Releases=0,
        /** @var int */
        public int $PingsCascaded=0,
        /** @var int */
        public int $OffersExpired=0,
        /** @var int */
        public int $WitnessTenants=0,
        /** @var int */
        public int $WitnessOffersMade=0,
        /** @var int */
        public int $WitnessOffersExpired=0,
        /** @var array<string>|null */
        public ?array $WitnessErrors=null,
        /** @var int */
        public int $DiningReminders=0,
        /** @var int */
        public int $ThreadsScheduled=0,
        /** @var int */
        public int $ThreadsClosed=0,
        /** @var int */
        public int $RoleChanges=0,
        /** @var int */
        public int $RoleReleases=0,
        /** @var int */
        public int $OfferPushes=0,
        /** @var int */
        public int $CourierTenants=0,
        /** @var int */
        public int $CourierOffers=0,
        /** @var int */
        public int $CourierHeld=0,
        /** @var int */
        public int $CourierLapsed=0,
        /** @var int */
        public int $CourierBooked=0,
        /** @var array<string>|null */
        public ?array $CourierErrors=null,
        /** @var int */
        public int $WorkPhotosPurged=0,
        /** @var int */
        public int $SmsMessagesPurged=0,
        /** @var int */
        public int $SecretsRewritten=0,
        /** @var array<DispatchHeartbeatTenantResult>|null */
        public ?array $Results=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Tenants'])) $this->Tenants = $o['Tenants'];
        if (isset($o['Tickets'])) $this->Tickets = $o['Tickets'];
        if (isset($o['Releases'])) $this->Releases = $o['Releases'];
        if (isset($o['PingsCascaded'])) $this->PingsCascaded = $o['PingsCascaded'];
        if (isset($o['OffersExpired'])) $this->OffersExpired = $o['OffersExpired'];
        if (isset($o['WitnessTenants'])) $this->WitnessTenants = $o['WitnessTenants'];
        if (isset($o['WitnessOffersMade'])) $this->WitnessOffersMade = $o['WitnessOffersMade'];
        if (isset($o['WitnessOffersExpired'])) $this->WitnessOffersExpired = $o['WitnessOffersExpired'];
        if (isset($o['WitnessErrors'])) $this->WitnessErrors = JsonConverters::fromArray('string', $o['WitnessErrors']);
        if (isset($o['DiningReminders'])) $this->DiningReminders = $o['DiningReminders'];
        if (isset($o['ThreadsScheduled'])) $this->ThreadsScheduled = $o['ThreadsScheduled'];
        if (isset($o['ThreadsClosed'])) $this->ThreadsClosed = $o['ThreadsClosed'];
        if (isset($o['RoleChanges'])) $this->RoleChanges = $o['RoleChanges'];
        if (isset($o['RoleReleases'])) $this->RoleReleases = $o['RoleReleases'];
        if (isset($o['OfferPushes'])) $this->OfferPushes = $o['OfferPushes'];
        if (isset($o['CourierTenants'])) $this->CourierTenants = $o['CourierTenants'];
        if (isset($o['CourierOffers'])) $this->CourierOffers = $o['CourierOffers'];
        if (isset($o['CourierHeld'])) $this->CourierHeld = $o['CourierHeld'];
        if (isset($o['CourierLapsed'])) $this->CourierLapsed = $o['CourierLapsed'];
        if (isset($o['CourierBooked'])) $this->CourierBooked = $o['CourierBooked'];
        if (isset($o['CourierErrors'])) $this->CourierErrors = JsonConverters::fromArray('string', $o['CourierErrors']);
        if (isset($o['WorkPhotosPurged'])) $this->WorkPhotosPurged = $o['WorkPhotosPurged'];
        if (isset($o['SmsMessagesPurged'])) $this->SmsMessagesPurged = $o['SmsMessagesPurged'];
        if (isset($o['SecretsRewritten'])) $this->SecretsRewritten = $o['SecretsRewritten'];
        if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('DispatchHeartbeatTenantResult', $o['Results']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Tenants)) $o['Tenants'] = $this->Tenants;
        if (isset($this->Tickets)) $o['Tickets'] = $this->Tickets;
        if (isset($this->Releases)) $o['Releases'] = $this->Releases;
        if (isset($this->PingsCascaded)) $o['PingsCascaded'] = $this->PingsCascaded;
        if (isset($this->OffersExpired)) $o['OffersExpired'] = $this->OffersExpired;
        if (isset($this->WitnessTenants)) $o['WitnessTenants'] = $this->WitnessTenants;
        if (isset($this->WitnessOffersMade)) $o['WitnessOffersMade'] = $this->WitnessOffersMade;
        if (isset($this->WitnessOffersExpired)) $o['WitnessOffersExpired'] = $this->WitnessOffersExpired;
        if (isset($this->WitnessErrors)) $o['WitnessErrors'] = JsonConverters::toArray('string', $this->WitnessErrors);
        if (isset($this->DiningReminders)) $o['DiningReminders'] = $this->DiningReminders;
        if (isset($this->ThreadsScheduled)) $o['ThreadsScheduled'] = $this->ThreadsScheduled;
        if (isset($this->ThreadsClosed)) $o['ThreadsClosed'] = $this->ThreadsClosed;
        if (isset($this->RoleChanges)) $o['RoleChanges'] = $this->RoleChanges;
        if (isset($this->RoleReleases)) $o['RoleReleases'] = $this->RoleReleases;
        if (isset($this->OfferPushes)) $o['OfferPushes'] = $this->OfferPushes;
        if (isset($this->CourierTenants)) $o['CourierTenants'] = $this->CourierTenants;
        if (isset($this->CourierOffers)) $o['CourierOffers'] = $this->CourierOffers;
        if (isset($this->CourierHeld)) $o['CourierHeld'] = $this->CourierHeld;
        if (isset($this->CourierLapsed)) $o['CourierLapsed'] = $this->CourierLapsed;
        if (isset($this->CourierBooked)) $o['CourierBooked'] = $this->CourierBooked;
        if (isset($this->CourierErrors)) $o['CourierErrors'] = JsonConverters::toArray('string', $this->CourierErrors);
        if (isset($this->WorkPhotosPurged)) $o['WorkPhotosPurged'] = $this->WorkPhotosPurged;
        if (isset($this->SmsMessagesPurged)) $o['SmsMessagesPurged'] = $this->SmsMessagesPurged;
        if (isset($this->SecretsRewritten)) $o['SecretsRewritten'] = $this->SecretsRewritten;
        if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('DispatchHeartbeatTenantResult', $this->Results);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

PHP DispatchHeartbeatRequest 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 /v1/dispatch/heartbeat HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchHeartbeatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
</DispatchHeartbeatRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchHeartbeatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CourierBooked>0</CourierBooked>
  <CourierErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CourierErrors>
  <CourierHeld>0</CourierHeld>
  <CourierLapsed>0</CourierLapsed>
  <CourierOffers>0</CourierOffers>
  <CourierTenants>0</CourierTenants>
  <DiningReminders>0</DiningReminders>
  <OfferPushes>0</OfferPushes>
  <OffersExpired>0</OffersExpired>
  <PingsCascaded>0</PingsCascaded>
  <Releases>0</Releases>
  <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>
  <Results>
    <DispatchHeartbeatTenantResult>
      <Error>String</Error>
      <OffersExpired>0</OffersExpired>
      <PingsCascaded>0</PingsCascaded>
      <Releases>0</Releases>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
      <Tickets>0</Tickets>
    </DispatchHeartbeatTenantResult>
  </Results>
  <RoleChanges>0</RoleChanges>
  <RoleReleases>0</RoleReleases>
  <SecretsRewritten>0</SecretsRewritten>
  <SmsMessagesPurged>0</SmsMessagesPurged>
  <Tenants>0</Tenants>
  <ThreadsClosed>0</ThreadsClosed>
  <ThreadsScheduled>0</ThreadsScheduled>
  <Tickets>0</Tickets>
  <WitnessErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </WitnessErrors>
  <WitnessOffersExpired>0</WitnessOffersExpired>
  <WitnessOffersMade>0</WitnessOffersMade>
  <WitnessTenants>0</WitnessTenants>
  <WorkPhotosPurged>0</WorkPhotosPurged>
</DispatchHeartbeatResponse>