Trendsic Platform Service

HoldPlaceRequest

The following routes are available for this service:
POST,OPTIONS	/v1/records/holds

<?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 RecordsOkResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Ok=null,
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Key=null,
        /** @var array<string>|null */
        public ?array $Matches=null
    ) {
    }

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

class HoldPlaceRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Matter=null,
        /** @var string|null */
        public ?string $ScopeDim=null,
        /** @var string|null */
        public ?string $ScopeVal=null,
        /** @var bool|null */
        public ?bool $DryRun=null
    ) {
    }

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

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

POST /v1/records/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Matter: String,
	ScopeDim: String,
	ScopeVal: String,
	DryRun: False
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Ok: False,
	Id: 0,
	Key: String,
	Matches: 
	[
		String
	]
}