Trendsic Platform Service

RoutePlanForecastMoveRequest

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

<?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 RoutePlanMoveResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Moved=0,
        /** @var int */
        public int $Dropped=0,
        /** @var int */
        public int $Kept=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

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

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

class RoutePlanForecastMoveRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Dest=null,
        /** @var array<RoutePlanForecastMoveItem>|null */
        public ?array $Items=null
    ) {
    }

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

PHP RoutePlanForecastMoveRequest 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/forecast/move HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Dest":"String","Items":[{"AgreementID":0,"AgreementJobID":0,"DateIso":"String"}]}

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

{"Moved":0,"Dropped":0,"Kept":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}