Trendsic Platform Service

<back to all web services

RecordSeriesSaveRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/records/series/{SeriesId}
POST,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 RecordsOkResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Ok=null,
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Key=null,
        /** @var array<string>|null */
        public ?array $Matches=null
    ) {
    }

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

class RecordSeriesSaveRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SeriesId=0,
        /** @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
    ) {
    }

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

PHP RecordSeriesSaveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/records/series HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SeriesId":0,"Code":"String","Name":"String","Years":0,"Permanent":false,"RetClass":"String","TriggerEvent":"String","Method":"String","ImageAndDestroy":false,"Citation":"String","FieldsJson":"String"}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Ok":false,"Id":0,"Key":"String","Matches":["String"]}