Trendsic Platform Service

<back to all web services

PortalQuoteRequest

The following routes are available for this service:
GET,OPTIONS/portal/{Token}/quote
<?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 QuoteItem implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $QuoteItemID=0,
        /** @var int */
        public int $QuoteID=0,
        /** @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 $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var float|null */
        public ?float $Quantity=null,
        /** @var float|null */
        public ?float $UnitPrice=null,
        /** @var bool|null */
        public ?bool $IsTaxable=null,
        /** @var int|null */
        public ?int $DisplayOrder=null,
        /** @var bool|null */
        public ?bool $IsDeleted=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['QuoteItemID'])) $this->QuoteItemID = $o['QuoteItemID'];
        if (isset($o['QuoteID'])) $this->QuoteID = $o['QuoteID'];
        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['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
        if (isset($o['UnitPrice'])) $this->UnitPrice = $o['UnitPrice'];
        if (isset($o['IsTaxable'])) $this->IsTaxable = $o['IsTaxable'];
        if (isset($o['DisplayOrder'])) $this->DisplayOrder = $o['DisplayOrder'];
        if (isset($o['IsDeleted'])) $this->IsDeleted = $o['IsDeleted'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->QuoteItemID)) $o['QuoteItemID'] = $this->QuoteItemID;
        if (isset($this->QuoteID)) $o['QuoteID'] = $this->QuoteID;
        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->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
        if (isset($this->UnitPrice)) $o['UnitPrice'] = $this->UnitPrice;
        if (isset($this->IsTaxable)) $o['IsTaxable'] = $this->IsTaxable;
        if (isset($this->DisplayOrder)) $o['DisplayOrder'] = $this->DisplayOrder;
        if (isset($this->IsDeleted)) $o['IsDeleted'] = $this->IsDeleted;
        return empty($o) ? new class(){} : $o;
    }
}

class PortalQuoteResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Currency=null,
        /** @var float */
        public float $Total=0.0,
        /** @var string|null */
        public ?string $Notes=null,
        /** @var string|null */
        public ?string $FromName=null,
        /** @var string|null */
        public ?string $FromAddress=null,
        /** @var string|null */
        public ?string $ToName=null,
        /** @var string|null */
        public ?string $ToAddress=null,
        /** @var DateTime|null */
        public ?DateTime $ExpiresAt=null,
        /** @var bool|null */
        public ?bool $IsLocked=null,
        /** @var bool|null */
        public ?bool $FinalPriceAfterCompletion=null,
        /** @var string|null */
        public ?string $ApprovedByName=null,
        /** @var DateTime|null */
        public ?DateTime $ApprovedAt=null,
        /** @var string|null */
        public ?string $DeclinedByName=null,
        /** @var DateTime|null */
        public ?DateTime $DeclinedAt=null,
        /** @var string|null */
        public ?string $DeclineReason=null,
        /** @var array<QuoteItem>|null */
        public ?array $LineItems=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Currency'])) $this->Currency = $o['Currency'];
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        if (isset($o['FromName'])) $this->FromName = $o['FromName'];
        if (isset($o['FromAddress'])) $this->FromAddress = $o['FromAddress'];
        if (isset($o['ToName'])) $this->ToName = $o['ToName'];
        if (isset($o['ToAddress'])) $this->ToAddress = $o['ToAddress'];
        if (isset($o['ExpiresAt'])) $this->ExpiresAt = JsonConverters::from('DateTime', $o['ExpiresAt']);
        if (isset($o['IsLocked'])) $this->IsLocked = $o['IsLocked'];
        if (isset($o['FinalPriceAfterCompletion'])) $this->FinalPriceAfterCompletion = $o['FinalPriceAfterCompletion'];
        if (isset($o['ApprovedByName'])) $this->ApprovedByName = $o['ApprovedByName'];
        if (isset($o['ApprovedAt'])) $this->ApprovedAt = JsonConverters::from('DateTime', $o['ApprovedAt']);
        if (isset($o['DeclinedByName'])) $this->DeclinedByName = $o['DeclinedByName'];
        if (isset($o['DeclinedAt'])) $this->DeclinedAt = JsonConverters::from('DateTime', $o['DeclinedAt']);
        if (isset($o['DeclineReason'])) $this->DeclineReason = $o['DeclineReason'];
        if (isset($o['LineItems'])) $this->LineItems = JsonConverters::fromArray('QuoteItem', $o['LineItems']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Currency)) $o['Currency'] = $this->Currency;
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->FromName)) $o['FromName'] = $this->FromName;
        if (isset($this->FromAddress)) $o['FromAddress'] = $this->FromAddress;
        if (isset($this->ToName)) $o['ToName'] = $this->ToName;
        if (isset($this->ToAddress)) $o['ToAddress'] = $this->ToAddress;
        if (isset($this->ExpiresAt)) $o['ExpiresAt'] = JsonConverters::to('DateTime', $this->ExpiresAt);
        if (isset($this->IsLocked)) $o['IsLocked'] = $this->IsLocked;
        if (isset($this->FinalPriceAfterCompletion)) $o['FinalPriceAfterCompletion'] = $this->FinalPriceAfterCompletion;
        if (isset($this->ApprovedByName)) $o['ApprovedByName'] = $this->ApprovedByName;
        if (isset($this->ApprovedAt)) $o['ApprovedAt'] = JsonConverters::to('DateTime', $this->ApprovedAt);
        if (isset($this->DeclinedByName)) $o['DeclinedByName'] = $this->DeclinedByName;
        if (isset($this->DeclinedAt)) $o['DeclinedAt'] = JsonConverters::to('DateTime', $this->DeclinedAt);
        if (isset($this->DeclineReason)) $o['DeclineReason'] = $this->DeclineReason;
        if (isset($this->LineItems)) $o['LineItems'] = JsonConverters::toArray('QuoteItem', $this->LineItems);
        return empty($o) ? new class(){} : $o;
    }
}

class PortalQuoteRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Token=null
    ) {
    }

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

PHP PortalQuoteRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /portal/{Token}/quote HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Name":"String","Status":"String","Currency":"String","Total":0,"Notes":"String","FromName":"String","FromAddress":"String","ToName":"String","ToAddress":"String","ExpiresAt":"0001-01-01T00:00:00.0000000","IsLocked":false,"FinalPriceAfterCompletion":false,"ApprovedByName":"String","ApprovedAt":"0001-01-01T00:00:00.0000000","DeclinedByName":"String","DeclinedAt":"0001-01-01T00:00:00.0000000","DeclineReason":"String","LineItems":[{"QuoteItemID":0,"QuoteID":0,"ItemType":"String","SourceRefId":0,"JobID":0,"Name":"String","Description":"String","Quantity":0,"UnitPrice":0,"IsTaxable":false,"DisplayOrder":0,"IsDeleted":false}]}