Trendsic Platform Service

<back to all web services

EquipmentRateRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Equipment/{EquipmentID}/rates
PUT,DELETE,OPTIONS/v1/Equipment/{EquipmentID}/rates/{EquipmentRateID}
<?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 EquipmentRate implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentRateID=0,
        /** @var int */
        public int $EquipmentID=0,
        /** @var string|null */
        public ?string $RateType=null,
        /** @var float|null */
        public ?float $Charge=null,
        /** @var float|null */
        public ?float $Cost=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EquipmentRateID'])) $this->EquipmentRateID = $o['EquipmentRateID'];
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['RateType'])) $this->RateType = $o['RateType'];
        if (isset($o['Charge'])) $this->Charge = $o['Charge'];
        if (isset($o['Cost'])) $this->Cost = $o['Cost'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EquipmentRateID)) $o['EquipmentRateID'] = $this->EquipmentRateID;
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->RateType)) $o['RateType'] = $this->RateType;
        if (isset($this->Charge)) $o['Charge'] = $this->Charge;
        if (isset($this->Cost)) $o['Cost'] = $this->Cost;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class EquipmentRateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentID=0,
        /** @var int */
        public int $EquipmentRateID=0,
        /** @var array<EquipmentRate>|null */
        public ?array $Rates=null
    ) {
    }

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

PHP EquipmentRateRequest 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/Equipment/{EquipmentID}/rates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EquipmentRateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EquipmentID>0</EquipmentID>
  <EquipmentRateID>0</EquipmentRateID>
  <Rates>
    <EquipmentRate>
      <Charge>0</Charge>
      <Cost>0</Cost>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EquipmentID>0</EquipmentID>
      <EquipmentRateID>0</EquipmentRateID>
      <RateType>String</RateType>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </EquipmentRate>
  </Rates>
</EquipmentRateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EquipmentRateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Rates>
    <EquipmentRate>
      <Charge>0</Charge>
      <Cost>0</Cost>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EquipmentID>0</EquipmentID>
      <EquipmentRateID>0</EquipmentRateID>
      <RateType>String</RateType>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </EquipmentRate>
  </Rates>
  <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>
</EquipmentRateResponse>