Trendsic Platform Service

<back to all web services

QboPendingOrdersRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/qbo/pending-orders
<?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 QboPendingOrder implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $OrderID=0,
        /** @var string|null */
        public ?string $PublicOrderID=null,
        /** @var DateTime|null */
        public ?DateTime $OrderDate=null,
        /** @var float|null */
        public ?float $Total=null,
        /** @var string|null */
        public ?string $CustomerName=null
    ) {
    }

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

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

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

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

PHP QboPendingOrdersRequest DTOs

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

HTTP + XML

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

GET /v1/qbo/pending-orders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QboPendingOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Orders>
    <QboPendingOrder>
      <CustomerName>String</CustomerName>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <OrderID>0</OrderID>
      <PublicOrderID>String</PublicOrderID>
      <Total>0</Total>
    </QboPendingOrder>
  </Orders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</QboPendingOrdersResponse>