Trendsic Platform Service

<back to all web services

RecordsSettingsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/settings
<?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 WfBindingDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $SourceKey=null,
        /** @var int */
        public int $WorkflowId=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var bool|null */
        public ?bool $Paused=null,
        /** @var int */
        public int $Runs30=0,
        /** @var string|null */
        public ?string $Summary=null
    ) {
    }

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

class RecordsSettingsDto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ThresholdsJson=null,
        /** @var string|null */
        public ?string $VendorsJson=null,
        /** @var string|null */
        public ?string $ArchivalJson=null,
        /** @var string|null */
        public ?string $PoliciesJson=null,
        /** @var string|null */
        public ?string $VisibilityJson=null,
        /** @var array<WfBindingDto>|null */
        public ?array $WfBindings=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ThresholdsJson'])) $this->ThresholdsJson = $o['ThresholdsJson'];
        if (isset($o['VendorsJson'])) $this->VendorsJson = $o['VendorsJson'];
        if (isset($o['ArchivalJson'])) $this->ArchivalJson = $o['ArchivalJson'];
        if (isset($o['PoliciesJson'])) $this->PoliciesJson = $o['PoliciesJson'];
        if (isset($o['VisibilityJson'])) $this->VisibilityJson = $o['VisibilityJson'];
        if (isset($o['WfBindings'])) $this->WfBindings = JsonConverters::fromArray('WfBindingDto', $o['WfBindings']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ThresholdsJson)) $o['ThresholdsJson'] = $this->ThresholdsJson;
        if (isset($this->VendorsJson)) $o['VendorsJson'] = $this->VendorsJson;
        if (isset($this->ArchivalJson)) $o['ArchivalJson'] = $this->ArchivalJson;
        if (isset($this->PoliciesJson)) $o['PoliciesJson'] = $this->PoliciesJson;
        if (isset($this->VisibilityJson)) $o['VisibilityJson'] = $this->VisibilityJson;
        if (isset($this->WfBindings)) $o['WfBindings'] = JsonConverters::toArray('WfBindingDto', $this->WfBindings);
        return empty($o) ? new class(){} : $o;
    }
}

class RecordsSettingsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var RecordsSettingsDto|null */
        public ?RecordsSettingsDto $Settings=null
    ) {
    }

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

class RecordsSettingsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP RecordsSettingsRequest 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/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordsSettingsResponse 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>
  <Settings>
    <ArchivalJson>String</ArchivalJson>
    <PoliciesJson>String</PoliciesJson>
    <ThresholdsJson>String</ThresholdsJson>
    <VendorsJson>String</VendorsJson>
    <VisibilityJson>String</VisibilityJson>
    <WfBindings>
      <WfBindingDto>
        <Name>String</Name>
        <Paused>false</Paused>
        <Runs30>0</Runs30>
        <SourceKey>String</SourceKey>
        <Summary>String</Summary>
        <WorkflowId>0</WorkflowId>
      </WfBindingDto>
    </WfBindings>
  </Settings>
</RecordsSettingsResponse>