Trendsic Platform Service

<back to all web services

CourierDriverVehicleRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/worker/dispatch/od/vehicle
<?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 CourierVehicleClassView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $NameEs=null,
        /** @var string|null */
        public ?string $Hint=null,
        /** @var string|null */
        public ?string $HintEs=null,
        /** @var float */
        public float $Cap=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['NameEs'])) $this->NameEs = $o['NameEs'];
        if (isset($o['Hint'])) $this->Hint = $o['Hint'];
        if (isset($o['HintEs'])) $this->HintEs = $o['HintEs'];
        if (isset($o['Cap'])) $this->Cap = $o['Cap'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->NameEs)) $o['NameEs'] = $this->NameEs;
        if (isset($this->Hint)) $o['Hint'] = $this->Hint;
        if (isset($this->HintEs)) $o['HintEs'] = $this->HintEs;
        if (isset($this->Cap)) $o['Cap'] = $this->Cap;
        return empty($o) ? new class(){} : $o;
    }
}

class CourierDriverVehicleResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentID=0,
        /** @var string|null */
        public ?string $UnitNumber=null,
        /** @var bool|null */
        public ?bool $IsOwn=null,
        /** @var bool|null */
        public ?bool $SetByOffice=null,
        /** @var string|null */
        public ?string $ClassCode=null,
        /** @var string|null */
        public ?string $ClassName=null,
        /** @var string|null */
        public ?string $ClassNameEs=null,
        /** @var float|null */
        public ?float $Cap=null,
        /** @var string|null */
        public ?string $UnitOne=null,
        /** @var string|null */
        public ?string $UnitMany=null,
        /** @var string|null */
        public ?string $UnitOneEs=null,
        /** @var string|null */
        public ?string $UnitManyEs=null,
        /** @var array<CourierVehicleClassView>|null */
        public ?array $Classes=null,
        /** @var bool|null */
        public ?bool $Saved=null,
        /** @var string|null */
        public ?string $SavedText=null,
        /** @var string|null */
        public ?string $SavedTextEs=null,
        /** @var string|null */
        public ?string $MessageEs=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['UnitNumber'])) $this->UnitNumber = $o['UnitNumber'];
        if (isset($o['IsOwn'])) $this->IsOwn = $o['IsOwn'];
        if (isset($o['SetByOffice'])) $this->SetByOffice = $o['SetByOffice'];
        if (isset($o['ClassCode'])) $this->ClassCode = $o['ClassCode'];
        if (isset($o['ClassName'])) $this->ClassName = $o['ClassName'];
        if (isset($o['ClassNameEs'])) $this->ClassNameEs = $o['ClassNameEs'];
        if (isset($o['Cap'])) $this->Cap = $o['Cap'];
        if (isset($o['UnitOne'])) $this->UnitOne = $o['UnitOne'];
        if (isset($o['UnitMany'])) $this->UnitMany = $o['UnitMany'];
        if (isset($o['UnitOneEs'])) $this->UnitOneEs = $o['UnitOneEs'];
        if (isset($o['UnitManyEs'])) $this->UnitManyEs = $o['UnitManyEs'];
        if (isset($o['Classes'])) $this->Classes = JsonConverters::fromArray('CourierVehicleClassView', $o['Classes']);
        if (isset($o['Saved'])) $this->Saved = $o['Saved'];
        if (isset($o['SavedText'])) $this->SavedText = $o['SavedText'];
        if (isset($o['SavedTextEs'])) $this->SavedTextEs = $o['SavedTextEs'];
        if (isset($o['MessageEs'])) $this->MessageEs = $o['MessageEs'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->UnitNumber)) $o['UnitNumber'] = $this->UnitNumber;
        if (isset($this->IsOwn)) $o['IsOwn'] = $this->IsOwn;
        if (isset($this->SetByOffice)) $o['SetByOffice'] = $this->SetByOffice;
        if (isset($this->ClassCode)) $o['ClassCode'] = $this->ClassCode;
        if (isset($this->ClassName)) $o['ClassName'] = $this->ClassName;
        if (isset($this->ClassNameEs)) $o['ClassNameEs'] = $this->ClassNameEs;
        if (isset($this->Cap)) $o['Cap'] = $this->Cap;
        if (isset($this->UnitOne)) $o['UnitOne'] = $this->UnitOne;
        if (isset($this->UnitMany)) $o['UnitMany'] = $this->UnitMany;
        if (isset($this->UnitOneEs)) $o['UnitOneEs'] = $this->UnitOneEs;
        if (isset($this->UnitManyEs)) $o['UnitManyEs'] = $this->UnitManyEs;
        if (isset($this->Classes)) $o['Classes'] = JsonConverters::toArray('CourierVehicleClassView', $this->Classes);
        if (isset($this->Saved)) $o['Saved'] = $this->Saved;
        if (isset($this->SavedText)) $o['SavedText'] = $this->SavedText;
        if (isset($this->SavedTextEs)) $o['SavedTextEs'] = $this->SavedTextEs;
        if (isset($this->MessageEs)) $o['MessageEs'] = $this->MessageEs;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CourierDriverVehicleRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ClassCode=null
    ) {
    }

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

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

PUT /v1/worker/dispatch/od/vehicle HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierDriverVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ClassCode>String</ClassCode>
</CourierDriverVehicleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierDriverVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Cap>0</Cap>
  <ClassCode>String</ClassCode>
  <ClassName>String</ClassName>
  <ClassNameEs>String</ClassNameEs>
  <Classes>
    <CourierVehicleClassView>
      <Cap>0</Cap>
      <Code>String</Code>
      <Hint>String</Hint>
      <HintEs>String</HintEs>
      <Name>String</Name>
      <NameEs>String</NameEs>
    </CourierVehicleClassView>
  </Classes>
  <EquipmentID>0</EquipmentID>
  <IsOwn>false</IsOwn>
  <MessageEs>String</MessageEs>
  <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>
  <Saved>false</Saved>
  <SavedText>String</SavedText>
  <SavedTextEs>String</SavedTextEs>
  <SetByOffice>false</SetByOffice>
  <UnitMany>String</UnitMany>
  <UnitManyEs>String</UnitManyEs>
  <UnitNumber>String</UnitNumber>
  <UnitOne>String</UnitOne>
  <UnitOneEs>String</UnitOneEs>
</CourierDriverVehicleResponse>