Trendsic Platform Service

<back to all web services

ApsConfigPutRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/aps/config
<?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 ApsConfigResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Connected=null,
        /** @var string|null */
        public ?string $ClientIdMasked=null,
        /** @var bool|null */
        public ?bool $HasSecret=null,
        /** @var string|null */
        public ?string $BucketKey=null,
        /** @var string|null */
        public ?string $ConnectedAt=null,
        /** @var string|null */
        public ?string $LastCheck=null,
        /** @var bool|null */
        public ?bool $TestOk=null,
        /** @var string|null */
        public ?string $TestMessage=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Connected'])) $this->Connected = $o['Connected'];
        if (isset($o['ClientIdMasked'])) $this->ClientIdMasked = $o['ClientIdMasked'];
        if (isset($o['HasSecret'])) $this->HasSecret = $o['HasSecret'];
        if (isset($o['BucketKey'])) $this->BucketKey = $o['BucketKey'];
        if (isset($o['ConnectedAt'])) $this->ConnectedAt = $o['ConnectedAt'];
        if (isset($o['LastCheck'])) $this->LastCheck = $o['LastCheck'];
        if (isset($o['TestOk'])) $this->TestOk = $o['TestOk'];
        if (isset($o['TestMessage'])) $this->TestMessage = $o['TestMessage'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Connected)) $o['Connected'] = $this->Connected;
        if (isset($this->ClientIdMasked)) $o['ClientIdMasked'] = $this->ClientIdMasked;
        if (isset($this->HasSecret)) $o['HasSecret'] = $this->HasSecret;
        if (isset($this->BucketKey)) $o['BucketKey'] = $this->BucketKey;
        if (isset($this->ConnectedAt)) $o['ConnectedAt'] = $this->ConnectedAt;
        if (isset($this->LastCheck)) $o['LastCheck'] = $this->LastCheck;
        if (isset($this->TestOk)) $o['TestOk'] = $this->TestOk;
        if (isset($this->TestMessage)) $o['TestMessage'] = $this->TestMessage;
        return empty($o) ? new class(){} : $o;
    }
}

class ApsConfigPutRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ClientId=null,
        /** @var string|null */
        public ?string $ClientSecret=null
    ) {
    }

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

PHP ApsConfigPutRequest 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.

PUT /v1/aps/config HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApsConfigPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ClientId>String</ClientId>
  <ClientSecret>String</ClientSecret>
</ApsConfigPutRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApsConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BucketKey>String</BucketKey>
  <ClientIdMasked>String</ClientIdMasked>
  <Connected>false</Connected>
  <ConnectedAt>String</ConnectedAt>
  <HasSecret>false</HasSecret>
  <LastCheck>String</LastCheck>
  <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>
  <TestMessage>String</TestMessage>
  <TestOk>false</TestOk>
</ApsConfigResponse>