Trendsic Platform Service

<back to all web services

GetProvisionOptionsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/provision/options
<?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 PackOption implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string */
        public string $PackId=''
    ) {
    }

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

class RoleTemplate implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null
    ) {
    }

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

class StarterCatalogItem implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var float */
        public float $Rate=0.0
    ) {
    }

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

class ProvisionOptions implements JsonSerializable
{
    public function __construct(
        /** @var array<PackOption>|null */
        public ?array $Packs=null,
        /** @var array<string>|null */
        public ?array $TimeZones=null,
        /** @var array<RoleTemplate>|null */
        public ?array $RoleTemplates=null,
        /** @var array<StarterCatalogItem>|null */
        public ?array $StarterCatalog=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

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

PHP GetProvisionOptionsRequest DTOs

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

HTTP + CSV

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

GET /v1/provision/options HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Packs":[{"Code":"String","Name":"String","PackId":"00000000000000000000000000000000"}],"TimeZones":["String"],"RoleTemplates":[{"Name":"String","Description":"String"}],"StarterCatalog":[{"Name":"String","Rate":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}