Trendsic Platform Service

<back to all web services

EquipmentFleetRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Equipment/fleet
<?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 EquipmentVehicle implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentVehicleID=0,
        /** @var int */
        public int $EquipmentID=0,
        /** @var string|null */
        public ?string $UnitNumber=null,
        /** @var string|null */
        public ?string $VehicleType=null,
        /** @var string|null */
        public ?string $CapacityText=null,
        /** @var float|null */
        public ?float $CapacityTons=null,
        /** @var float|null */
        public ?float $DeckFeet=null,
        /** @var string|null */
        public ?string $Plate=null,
        /** @var string|null */
        public ?string $VIN=null,
        /** @var string|null */
        public ?string $GpsUnit=null,
        /** @var DateTime|null */
        public ?DateTime $InsuranceExpires=null,
        /** @var DateTime|null */
        public ?DateTime $InspectionDue=null,
        /** @var string|null */
        public ?string $Capabilities=null,
        /** @var string|null */
        public ?string $VehicleStatus=null,
        /** @var int|null */
        public ?int $VendorID=null,
        /** @var string|null */
        public ?string $EquipmentName=null,
        /** @var string|null */
        public ?string $Ownership=null,
        /** @var string|null */
        public ?string $RentalVendor=null,
        /** @var string|null */
        public ?string $TruckCode=null,
        /** @var string|null */
        public ?string $RigCode=null,
        /** @var string|null */
        public ?string $BoardModule=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EquipmentVehicleID'])) $this->EquipmentVehicleID = $o['EquipmentVehicleID'];
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['UnitNumber'])) $this->UnitNumber = $o['UnitNumber'];
        if (isset($o['VehicleType'])) $this->VehicleType = $o['VehicleType'];
        if (isset($o['CapacityText'])) $this->CapacityText = $o['CapacityText'];
        if (isset($o['CapacityTons'])) $this->CapacityTons = $o['CapacityTons'];
        if (isset($o['DeckFeet'])) $this->DeckFeet = $o['DeckFeet'];
        if (isset($o['Plate'])) $this->Plate = $o['Plate'];
        if (isset($o['VIN'])) $this->VIN = $o['VIN'];
        if (isset($o['GpsUnit'])) $this->GpsUnit = $o['GpsUnit'];
        if (isset($o['InsuranceExpires'])) $this->InsuranceExpires = JsonConverters::from('DateTime', $o['InsuranceExpires']);
        if (isset($o['InspectionDue'])) $this->InspectionDue = JsonConverters::from('DateTime', $o['InspectionDue']);
        if (isset($o['Capabilities'])) $this->Capabilities = $o['Capabilities'];
        if (isset($o['VehicleStatus'])) $this->VehicleStatus = $o['VehicleStatus'];
        if (isset($o['VendorID'])) $this->VendorID = $o['VendorID'];
        if (isset($o['EquipmentName'])) $this->EquipmentName = $o['EquipmentName'];
        if (isset($o['Ownership'])) $this->Ownership = $o['Ownership'];
        if (isset($o['RentalVendor'])) $this->RentalVendor = $o['RentalVendor'];
        if (isset($o['TruckCode'])) $this->TruckCode = $o['TruckCode'];
        if (isset($o['RigCode'])) $this->RigCode = $o['RigCode'];
        if (isset($o['BoardModule'])) $this->BoardModule = $o['BoardModule'];
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EquipmentVehicleID)) $o['EquipmentVehicleID'] = $this->EquipmentVehicleID;
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->UnitNumber)) $o['UnitNumber'] = $this->UnitNumber;
        if (isset($this->VehicleType)) $o['VehicleType'] = $this->VehicleType;
        if (isset($this->CapacityText)) $o['CapacityText'] = $this->CapacityText;
        if (isset($this->CapacityTons)) $o['CapacityTons'] = $this->CapacityTons;
        if (isset($this->DeckFeet)) $o['DeckFeet'] = $this->DeckFeet;
        if (isset($this->Plate)) $o['Plate'] = $this->Plate;
        if (isset($this->VIN)) $o['VIN'] = $this->VIN;
        if (isset($this->GpsUnit)) $o['GpsUnit'] = $this->GpsUnit;
        if (isset($this->InsuranceExpires)) $o['InsuranceExpires'] = JsonConverters::to('DateTime', $this->InsuranceExpires);
        if (isset($this->InspectionDue)) $o['InspectionDue'] = JsonConverters::to('DateTime', $this->InspectionDue);
        if (isset($this->Capabilities)) $o['Capabilities'] = $this->Capabilities;
        if (isset($this->VehicleStatus)) $o['VehicleStatus'] = $this->VehicleStatus;
        if (isset($this->VendorID)) $o['VendorID'] = $this->VendorID;
        if (isset($this->EquipmentName)) $o['EquipmentName'] = $this->EquipmentName;
        if (isset($this->Ownership)) $o['Ownership'] = $this->Ownership;
        if (isset($this->RentalVendor)) $o['RentalVendor'] = $this->RentalVendor;
        if (isset($this->TruckCode)) $o['TruckCode'] = $this->TruckCode;
        if (isset($this->RigCode)) $o['RigCode'] = $this->RigCode;
        if (isset($this->BoardModule)) $o['BoardModule'] = $this->BoardModule;
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

PHP EquipmentFleetRequest 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/Equipment/fleet HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<EquipmentVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Fleet>
    <EquipmentVehicle>
      <BoardModule>String</BoardModule>
      <Capabilities>String</Capabilities>
      <CapacityText>String</CapacityText>
      <CapacityTons>0</CapacityTons>
      <DeckFeet>0</DeckFeet>
      <EquipmentID>0</EquipmentID>
      <EquipmentName>String</EquipmentName>
      <EquipmentVehicleID>0</EquipmentVehicleID>
      <GpsUnit>String</GpsUnit>
      <InspectionDue>0001-01-01T00:00:00</InspectionDue>
      <InsuranceExpires>0001-01-01T00:00:00</InsuranceExpires>
      <Ownership>String</Ownership>
      <Plate>String</Plate>
      <RentalVendor>String</RentalVendor>
      <RigCode>String</RigCode>
      <TruckCode>String</TruckCode>
      <UnitNumber>String</UnitNumber>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <VIN>String</VIN>
      <VehicleStatus>String</VehicleStatus>
      <VehicleType>String</VehicleType>
      <VendorID>0</VendorID>
    </EquipmentVehicle>
  </Fleet>
  <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>
  <Vehicle>
    <BoardModule>String</BoardModule>
    <Capabilities>String</Capabilities>
    <CapacityText>String</CapacityText>
    <CapacityTons>0</CapacityTons>
    <DeckFeet>0</DeckFeet>
    <EquipmentID>0</EquipmentID>
    <EquipmentName>String</EquipmentName>
    <EquipmentVehicleID>0</EquipmentVehicleID>
    <GpsUnit>String</GpsUnit>
    <InspectionDue>0001-01-01T00:00:00</InspectionDue>
    <InsuranceExpires>0001-01-01T00:00:00</InsuranceExpires>
    <Ownership>String</Ownership>
    <Plate>String</Plate>
    <RentalVendor>String</RentalVendor>
    <RigCode>String</RigCode>
    <TruckCode>String</TruckCode>
    <UnitNumber>String</UnitNumber>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <VIN>String</VIN>
    <VehicleStatus>String</VehicleStatus>
    <VehicleType>String</VehicleType>
    <VendorID>0</VendorID>
  </Vehicle>
</EquipmentVehicleResponse>