Trendsic Platform Service

<back to all web services

InventoryRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Inventory/{InventoryID}
GET,POST,PUT,DELETE,OPTIONS/v1/Inventory
<?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 Inventory implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $InventoryID=0,
        /** @var int */
        public int $EquipmentID=0,
        /** @var DateTime */
        public DateTime $RecordCreatedDate=new DateTime(),
        /** @var DateTime */
        public DateTime $DeletedDate=new DateTime(),
        /** @var int */
        public int $Quantity=0,
        /** @var string|null */
        public ?string $InventoryLocation=null,
        /** @var string|null */
        public ?string $Notess=null,
        /** @var string */
        public string $CreatedByUID=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['InventoryID'])) $this->InventoryID = $o['InventoryID'];
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['RecordCreatedDate'])) $this->RecordCreatedDate = JsonConverters::from('DateTime', $o['RecordCreatedDate']);
        if (isset($o['DeletedDate'])) $this->DeletedDate = JsonConverters::from('DateTime', $o['DeletedDate']);
        if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
        if (isset($o['InventoryLocation'])) $this->InventoryLocation = $o['InventoryLocation'];
        if (isset($o['Notess'])) $this->Notess = $o['Notess'];
        if (isset($o['CreatedByUID'])) $this->CreatedByUID = $o['CreatedByUID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->InventoryID)) $o['InventoryID'] = $this->InventoryID;
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->RecordCreatedDate)) $o['RecordCreatedDate'] = JsonConverters::to('DateTime', $this->RecordCreatedDate);
        if (isset($this->DeletedDate)) $o['DeletedDate'] = JsonConverters::to('DateTime', $this->DeletedDate);
        if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
        if (isset($this->InventoryLocation)) $o['InventoryLocation'] = $this->InventoryLocation;
        if (isset($this->Notess)) $o['Notess'] = $this->Notess;
        if (isset($this->CreatedByUID)) $o['CreatedByUID'] = $this->CreatedByUID;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class InventoryRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $InventoryID=0,
        /** @var array<Inventory>|null */
        public ?array $Inventory=null
    ) {
    }

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

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

POST /v1/Inventory/{InventoryID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InventoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Inventory>
    <Inventory>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <DeletedDate>0001-01-01T00:00:00</DeletedDate>
      <EquipmentID>0</EquipmentID>
      <InventoryID>0</InventoryID>
      <InventoryLocation>String</InventoryLocation>
      <Notess>String</Notess>
      <Quantity>0</Quantity>
      <RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
    </Inventory>
  </Inventory>
  <InventoryID>0</InventoryID>
</InventoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InventoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Inventory>
    <Inventory>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <DeletedDate>0001-01-01T00:00:00</DeletedDate>
      <EquipmentID>0</EquipmentID>
      <InventoryID>0</InventoryID>
      <InventoryLocation>String</InventoryLocation>
      <Notess>String</Notess>
      <Quantity>0</Quantity>
      <RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
    </Inventory>
  </Inventory>
  <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>
</InventoryResponse>