Trendsic Platform Service

<back to all web services

QuoteScopeRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/project/{ProjectUID}/quote-scope
<?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 QuoteScopeItem implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ItemType=null,
        /** @var int|null */
        public ?int $SourceRefId=null,
        /** @var int|null */
        public ?int $JobID=null,
        /** @var string|null */
        public ?string $JobName=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var float|null */
        public ?float $Quantity=null,
        /** @var float|null */
        public ?float $UnitPrice=null
    ) {
    }

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

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

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

class QuoteScopeRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ProjectUID=''
    ) {
    }

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

PHP QuoteScopeRequest 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/project/{ProjectUID}/quote-scope HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	ScopeItems: 
	[
		{
			ItemType: String,
			SourceRefId: 0,
			JobID: 0,
			JobName: String,
			Name: String,
			Quantity: 0,
			UnitPrice: 0
		}
	]
}