Trendsic Platform Service

<back to all web services

PmCatalogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/catalog
<?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 PmCatalogItem implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var float */
        public float $Amount=0.0
    ) {
    }

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

class PmCatalogCrew implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var array<int>|null */
        public ?array $MemberIds=null
    ) {
    }

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

class PmCatalogResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<PmCatalogItem>|null */
        public ?array $Statuses=null,
        /** @var array<PmCatalogItem>|null */
        public ?array $Crew=null,
        /** @var array<PmCatalogCrew>|null */
        public ?array $Crews=null,
        /** @var array<PmCatalogItem>|null */
        public ?array $Equipment=null,
        /** @var array<PmCatalogItem>|null */
        public ?array $Materials=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

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

PHP PmCatalogRequest DTOs

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

HTTP + JSV

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

GET /v1/pm/catalog HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Statuses: 
	[
		{
			Id: 0,
			Name: String,
			Amount: 0
		}
	],
	Crew: 
	[
		{
			Id: 0,
			Name: String,
			Amount: 0
		}
	],
	Crews: 
	[
		{
			Id: 0,
			Name: String,
			MemberIds: 
			[
				0
			]
		}
	],
	Equipment: 
	[
		{
			Id: 0,
			Name: String,
			Amount: 0
		}
	],
	Materials: 
	[
		{
			Id: 0,
			Name: String,
			Amount: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}