Trendsic Platform Service

<back to all web services

RoutePlanOptimizeRequest

<?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 RoutePlanOptimizeAssignment implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgreementID=0,
        /** @var int */
        public int $CrewID=0,
        /** @var int */
        public int $Seq=0
    ) {
    }

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

class RoutePlanOptimizeResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<RoutePlanOptimizeAssignment>|null */
        public ?array $Assignments=null,
        /** @var int */
        public int $ByDefaultCrew=0,
        /** @var int */
        public int $ByTerritory=0,
        /** @var int */
        public int $SkippedHeld=0,
        /** @var string|null */
        public ?string $Engine=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class RoutePlanOptimizeRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $DateIso=null,
        /** @var int */
        public int $HoldDays=0
    ) {
    }

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

PHP RoutePlanOptimizeRequest DTOs

POST /v1/routeplan/optimize HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RoutePlanOptimizeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DateIso>String</DateIso>
  <HoldDays>0</HoldDays>
</RoutePlanOptimizeRequest>

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

<RoutePlanOptimizeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Assignments>
    <RoutePlanOptimizeAssignment>
      <AgreementID>0</AgreementID>
      <CrewID>0</CrewID>
      <Seq>0</Seq>
    </RoutePlanOptimizeAssignment>
  </Assignments>
  <ByDefaultCrew>0</ByDefaultCrew>
  <ByTerritory>0</ByTerritory>
  <Engine>String</Engine>
  <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>
  <SkippedHeld>0</SkippedHeld>
</RoutePlanOptimizeResponse>