Trendsic Platform Service

<back to all web services

TerminologyAdminRequest

<?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 IndustryPack implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $PackId='',
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var bool|null */
        public ?bool $IsActive=null
    ) {
    }

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

class TermOverride implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TermKey=null,
        /** @var string|null */
        public ?string $Label=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

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

class TerminologyAdminResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<IndustryPack>|null */
        public ?array $Packs=null,
        /** @var string|null */
        public ?string $SelectedPackId=null,
        /** @var array<string,string>|null */
        public ?array $Terms=null,
        /** @var array<TermOverride>|null */
        public ?array $Overrides=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Packs'])) $this->Packs = JsonConverters::fromArray('IndustryPack', $o['Packs']);
        if (isset($o['SelectedPackId'])) $this->SelectedPackId = $o['SelectedPackId'];
        if (isset($o['Terms'])) $this->Terms = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Terms']);
        if (isset($o['Overrides'])) $this->Overrides = JsonConverters::fromArray('TermOverride', $o['Overrides']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Packs)) $o['Packs'] = JsonConverters::toArray('IndustryPack', $this->Packs);
        if (isset($this->SelectedPackId)) $o['SelectedPackId'] = $this->SelectedPackId;
        if (isset($this->Terms)) $o['Terms'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Terms);
        if (isset($this->Overrides)) $o['Overrides'] = JsonConverters::toArray('TermOverride', $this->Overrides);
        return empty($o) ? new class(){} : $o;
    }
}

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

PHP TerminologyAdminRequest DTOs

GET /v1/terminology/admin HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<TerminologyAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Overrides>
    <TermOverride>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Label>String</Label>
      <TermKey>String</TermKey>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </TermOverride>
  </Overrides>
  <Packs>
    <IndustryPack>
      <Code>String</Code>
      <IsActive>false</IsActive>
      <Name>String</Name>
      <PackId>00000000-0000-0000-0000-000000000000</PackId>
    </IndustryPack>
  </Packs>
  <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>
  <SelectedPackId>00000000-0000-0000-0000-000000000000</SelectedPackId>
  <Terms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Terms>
</TerminologyAdminResponse>