Trendsic Platform Service

RoutePlanOptimizeRequest

The following routes are available for this service:
POST,OPTIONS	/v1/routeplan/optimize

<?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

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"DateIso":"String","HoldDays":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Assignments":[{"AgreementID":0,"CrewID":0,"Seq":0}],"ByDefaultCrew":0,"ByTerritory":0,"SkippedHeld":0,"Engine":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}