Trendsic Platform Service

<back to all web services

PortalAccountRequest

The following routes are available for this service:
GET,OPTIONS/v1/portal/account/{Token}
<?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 PortalAccountVisit implements JsonSerializable
{
    public function __construct(
        /** @var DateTime|null */
        public ?DateTime $VisitDate=null,
        /** @var string|null */
        public ?string $ServiceName=null,
        /** @var string|null */
        public ?string $ProjectName=null
    ) {
    }

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

class PortalAccountInvoice implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $InvoiceUID=null,
        /** @var string|null */
        public ?string $InvoiceNumber=null,
        /** @var DateTime|null */
        public ?DateTime $InvoiceDate=null,
        /** @var float|null */
        public ?float $Total=null,
        /** @var bool|null */
        public ?bool $IsPaid=null,
        /** @var string|null */
        public ?string $ProjectName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['InvoiceUID'])) $this->InvoiceUID = $o['InvoiceUID'];
        if (isset($o['InvoiceNumber'])) $this->InvoiceNumber = $o['InvoiceNumber'];
        if (isset($o['InvoiceDate'])) $this->InvoiceDate = JsonConverters::from('DateTime', $o['InvoiceDate']);
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['IsPaid'])) $this->IsPaid = $o['IsPaid'];
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->InvoiceUID)) $o['InvoiceUID'] = $this->InvoiceUID;
        if (isset($this->InvoiceNumber)) $o['InvoiceNumber'] = $this->InvoiceNumber;
        if (isset($this->InvoiceDate)) $o['InvoiceDate'] = JsonConverters::to('DateTime', $this->InvoiceDate);
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->IsPaid)) $o['IsPaid'] = $this->IsPaid;
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        return empty($o) ? new class(){} : $o;
    }
}

class PortalAccountQuote implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $QuoteUID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var float|null */
        public ?float $Total=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $ProjectName=null
    ) {
    }

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

class PortalAccount implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $CustomerName=null,
        /** @var array<PortalAccountVisit>|null */
        public ?array $Visits=null,
        /** @var array<PortalAccountInvoice>|null */
        public ?array $Invoices=null,
        /** @var array<PortalAccountQuote>|null */
        public ?array $Quotes=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class PortalAccountRequest 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 PortalAccountRequest 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 /v1/portal/account/{Token} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"CustomerName":"String","Visits":[{"VisitDate":"0001-01-01T00:00:00.0000000","ServiceName":"String","ProjectName":"String"}],"Invoices":[{"InvoiceUID":"00000000000000000000000000000000","InvoiceNumber":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","Total":0,"IsPaid":false,"ProjectName":"String"}],"Quotes":[{"QuoteUID":"00000000000000000000000000000000","Name":"String","Total":0,"Status":"String","ProjectName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}