Trendsic Platform Service

ResourceRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,OPTIONS	/v1/Resource

<?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 ResourceCategory implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $CategoryName=null,
        /** @var array<string>|null */
        public ?array $Subcategories=null
    ) {
    }

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

class Document implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentId='',
        /** @var string|null */
        public ?string $DocType=null,
        /** @var string|null */
        public ?string $DocCategory=null,
        /** @var string|null */
        public ?string $DocSubCategory=null,
        /** @var string|null */
        public ?string $DocTitle=null,
        /** @var string|null */
        public ?string $DocDescription=null,
        /** @var ByteArray|null */
        public ?ByteArray $DocData=null,
        /** @var DateTime|null */
        public ?DateTime $DocExpiration=null,
        /** @var string|null */
        public ?string $DocMimeType=null,
        /** @var int */
        public int $DisplayOrder=0,
        /** @var float */
        public float $FileSizeInKB=0.0,
        /** @var string|null */
        public ?string $Link=null,
        /** @var DateTime|null */
        public ?DateTime $UploadDate=null,
        /** @var string|null */
        public ?string $DocKey=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DocumentId'])) $this->DocumentId = $o['DocumentId'];
        if (isset($o['DocType'])) $this->DocType = $o['DocType'];
        if (isset($o['DocCategory'])) $this->DocCategory = $o['DocCategory'];
        if (isset($o['DocSubCategory'])) $this->DocSubCategory = $o['DocSubCategory'];
        if (isset($o['DocTitle'])) $this->DocTitle = $o['DocTitle'];
        if (isset($o['DocDescription'])) $this->DocDescription = $o['DocDescription'];
        if (isset($o['DocData'])) $this->DocData = JsonConverters::from('ByteArray', $o['DocData']);
        if (isset($o['DocExpiration'])) $this->DocExpiration = JsonConverters::from('DateTime', $o['DocExpiration']);
        if (isset($o['DocMimeType'])) $this->DocMimeType = $o['DocMimeType'];
        if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
        if (isset($o['FileSizeInKB'])) $this->FileSizeInKB = $o['FileSizeInKB'];
        if (isset($o['Link'])) $this->Link = $o['Link'];
        if (isset($o['UploadDate'])) $this->UploadDate = JsonConverters::from('DateTime', $o['UploadDate']);
        if (isset($o['DocKey'])) $this->DocKey = $o['DocKey'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DocumentId)) $o['DocumentId'] = $this->DocumentId;
        if (isset($this->DocType)) $o['DocType'] = $this->DocType;
        if (isset($this->DocCategory)) $o['DocCategory'] = $this->DocCategory;
        if (isset($this->DocSubCategory)) $o['DocSubCategory'] = $this->DocSubCategory;
        if (isset($this->DocTitle)) $o['DocTitle'] = $this->DocTitle;
        if (isset($this->DocDescription)) $o['DocDescription'] = $this->DocDescription;
        if (isset($this->DocData)) $o['DocData'] = JsonConverters::to('ByteArray', $this->DocData);
        if (isset($this->DocExpiration)) $o['DocExpiration'] = JsonConverters::to('DateTime', $this->DocExpiration);
        if (isset($this->DocMimeType)) $o['DocMimeType'] = $this->DocMimeType;
        if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
        if (isset($this->FileSizeInKB)) $o['FileSizeInKB'] = $this->FileSizeInKB;
        if (isset($this->Link)) $o['Link'] = $this->Link;
        if (isset($this->UploadDate)) $o['UploadDate'] = JsonConverters::to('DateTime', $this->UploadDate);
        if (isset($this->DocKey)) $o['DocKey'] = $this->DocKey;
        return empty($o) ? new class(){} : $o;
    }
}

class Resource implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ResourceType=null,
        /** @var array<ResourceCategory>|null */
        public ?array $Categories=null,
        /** @var array<Document>|null */
        public ?array $Documents=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResourceType'])) $this->ResourceType = $o['ResourceType'];
        if (isset($o['Categories'])) $this->Categories = JsonConverters::fromArray('ResourceCategory', $o['Categories']);
        if (isset($o['Documents'])) $this->Documents = JsonConverters::fromArray('Document', $o['Documents']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResourceType)) $o['ResourceType'] = $this->ResourceType;
        if (isset($this->Categories)) $o['Categories'] = JsonConverters::toArray('ResourceCategory', $this->Categories);
        if (isset($this->Documents)) $o['Documents'] = JsonConverters::toArray('Document', $this->Documents);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ResourceRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<Resource>|null */
        public ?array $Resource=null
    ) {
    }

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

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

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

<ResourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Resource>
    <Resource>
      <Categories>
        <ResourceCategory>
          <CategoryName>String</CategoryName>
          <Subcategories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Subcategories>
        </ResourceCategory>
      </Categories>
      <Documents>
        <Document>
          <DisplayOrder>0</DisplayOrder>
          <DocCategory>String</DocCategory>
          <DocData>AA==</DocData>
          <DocDescription>String</DocDescription>
          <DocExpiration>0001-01-01T00:00:00</DocExpiration>
          <DocKey>String</DocKey>
          <DocMimeType>String</DocMimeType>
          <DocSubCategory>String</DocSubCategory>
          <DocTitle>String</DocTitle>
          <DocType>String</DocType>
          <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
          <FileSizeInKB>0</FileSizeInKB>
          <Link>String</Link>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
        </Document>
      </Documents>
      <ResourceType>String</ResourceType>
    </Resource>
  </Resource>
</ResourceRequest>

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

<ResourceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Resource>
    <Resource>
      <Categories>
        <ResourceCategory>
          <CategoryName>String</CategoryName>
          <Subcategories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Subcategories>
        </ResourceCategory>
      </Categories>
      <Documents>
        <Document>
          <DisplayOrder>0</DisplayOrder>
          <DocCategory>String</DocCategory>
          <DocData>AA==</DocData>
          <DocDescription>String</DocDescription>
          <DocExpiration>0001-01-01T00:00:00</DocExpiration>
          <DocKey>String</DocKey>
          <DocMimeType>String</DocMimeType>
          <DocSubCategory>String</DocSubCategory>
          <DocTitle>String</DocTitle>
          <DocType>String</DocType>
          <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
          <FileSizeInKB>0</FileSizeInKB>
          <Link>String</Link>
          <UploadDate>0001-01-01T00:00:00</UploadDate>
        </Document>
      </Documents>
      <ResourceType>String</ResourceType>
    </Resource>
  </Resource>
  <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>
</ResourceResponse>