Trendsic Platform Service

<back to all web services

RecordSeriesListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/series
<?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 RecordSeriesStats implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Total=0,
        /** @var int */
        public int $Running=0,
        /** @var int */
        public int $Eligible=0,
        /** @var int */
        public int $Held=0,
        /** @var int */
        public int $Unstarted=0
    ) {
    }

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

class ScheduleLogDto implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $LogId=0,
        /** @var int|null */
        public ?int $SeriesId=null,
        /** @var string|null */
        public ?string $Verb=null,
        /** @var string|null */
        public ?string $Actor=null,
        /** @var string|null */
        public ?string $What=null,
        /** @var string|null */
        public ?string $WhenLabel=null
    ) {
    }

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

class RecordSeriesDto implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SeriesId=0,
        /** @var string|null */
        public ?string $SourceKey=null,
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var int */
        public int $Years=0,
        /** @var bool|null */
        public ?bool $Permanent=null,
        /** @var string|null */
        public ?string $RetClass=null,
        /** @var string|null */
        public ?string $TriggerEvent=null,
        /** @var string|null */
        public ?string $Method=null,
        /** @var bool|null */
        public ?bool $ImageAndDestroy=null,
        /** @var string|null */
        public ?string $Citation=null,
        /** @var string|null */
        public ?string $FieldsJson=null,
        /** @var bool|null */
        public ?bool $Retired=null,
        /** @var RecordSeriesStats|null */
        public ?RecordSeriesStats $Stats=null,
        /** @var array<ScheduleLogDto>|null */
        public ?array $History=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SeriesId'])) $this->SeriesId = $o['SeriesId'];
        if (isset($o['SourceKey'])) $this->SourceKey = $o['SourceKey'];
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Years'])) $this->Years = $o['Years'];
        if (isset($o['Permanent'])) $this->Permanent = $o['Permanent'];
        if (isset($o['RetClass'])) $this->RetClass = $o['RetClass'];
        if (isset($o['TriggerEvent'])) $this->TriggerEvent = $o['TriggerEvent'];
        if (isset($o['Method'])) $this->Method = $o['Method'];
        if (isset($o['ImageAndDestroy'])) $this->ImageAndDestroy = $o['ImageAndDestroy'];
        if (isset($o['Citation'])) $this->Citation = $o['Citation'];
        if (isset($o['FieldsJson'])) $this->FieldsJson = $o['FieldsJson'];
        if (isset($o['Retired'])) $this->Retired = $o['Retired'];
        if (isset($o['Stats'])) $this->Stats = JsonConverters::from('RecordSeriesStats', $o['Stats']);
        if (isset($o['History'])) $this->History = JsonConverters::fromArray('ScheduleLogDto', $o['History']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SeriesId)) $o['SeriesId'] = $this->SeriesId;
        if (isset($this->SourceKey)) $o['SourceKey'] = $this->SourceKey;
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Years)) $o['Years'] = $this->Years;
        if (isset($this->Permanent)) $o['Permanent'] = $this->Permanent;
        if (isset($this->RetClass)) $o['RetClass'] = $this->RetClass;
        if (isset($this->TriggerEvent)) $o['TriggerEvent'] = $this->TriggerEvent;
        if (isset($this->Method)) $o['Method'] = $this->Method;
        if (isset($this->ImageAndDestroy)) $o['ImageAndDestroy'] = $this->ImageAndDestroy;
        if (isset($this->Citation)) $o['Citation'] = $this->Citation;
        if (isset($this->FieldsJson)) $o['FieldsJson'] = $this->FieldsJson;
        if (isset($this->Retired)) $o['Retired'] = $this->Retired;
        if (isset($this->Stats)) $o['Stats'] = JsonConverters::to('RecordSeriesStats', $this->Stats);
        if (isset($this->History)) $o['History'] = JsonConverters::toArray('ScheduleLogDto', $this->History);
        return empty($o) ? new class(){} : $o;
    }
}

class RecordSeriesListResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<RecordSeriesDto>|null */
        public ?array $Series=null
    ) {
    }

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

class RecordSeriesListRequest implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IncludeStats=null
    ) {
    }

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

PHP RecordSeriesListRequest 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/records/series HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<RecordSeriesListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Series>
    <RecordSeriesDto>
      <Citation>String</Citation>
      <Code>String</Code>
      <FieldsJson>String</FieldsJson>
      <History>
        <ScheduleLogDto>
          <Actor>String</Actor>
          <LogId>0</LogId>
          <SeriesId>0</SeriesId>
          <Verb>String</Verb>
          <What>String</What>
          <WhenLabel>String</WhenLabel>
        </ScheduleLogDto>
      </History>
      <ImageAndDestroy>false</ImageAndDestroy>
      <Method>String</Method>
      <Name>String</Name>
      <Permanent>false</Permanent>
      <RetClass>String</RetClass>
      <Retired>false</Retired>
      <SeriesId>0</SeriesId>
      <SourceKey>String</SourceKey>
      <Stats>
        <Eligible>0</Eligible>
        <Held>0</Held>
        <Running>0</Running>
        <Total>0</Total>
        <Unstarted>0</Unstarted>
      </Stats>
      <TriggerEvent>String</TriggerEvent>
      <Years>0</Years>
    </RecordSeriesDto>
  </Series>
</RecordSeriesListResponse>