Trendsic Platform Service

<back to all web services

RoutePlanPropertyCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/routeplan/property
<?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 RoutePlanPropertyCreateResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgreementID=0,
        /** @var int */
        public int $ProjectID=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class RoutePlanPropertyCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Acreage=null,
        /** @var int */
        public int $Minutes=0,
        /** @var string|null */
        public ?string $Profile=null,
        /** @var int */
        public int $Dow=0,
        /** @var array<int>|null */
        public ?array $EquipmentIDs=null,
        /** @var int */
        public int $TerritoryID=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Acreage'])) $this->Acreage = $o['Acreage'];
        if (isset($o['Minutes'])) $this->Minutes = $o['Minutes'];
        if (isset($o['Profile'])) $this->Profile = $o['Profile'];
        if (isset($o['Dow'])) $this->Dow = $o['Dow'];
        if (isset($o['EquipmentIDs'])) $this->EquipmentIDs = JsonConverters::fromArray('int', $o['EquipmentIDs']);
        if (isset($o['TerritoryID'])) $this->TerritoryID = $o['TerritoryID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Acreage)) $o['Acreage'] = $this->Acreage;
        if (isset($this->Minutes)) $o['Minutes'] = $this->Minutes;
        if (isset($this->Profile)) $o['Profile'] = $this->Profile;
        if (isset($this->Dow)) $o['Dow'] = $this->Dow;
        if (isset($this->EquipmentIDs)) $o['EquipmentIDs'] = JsonConverters::toArray('int', $this->EquipmentIDs);
        if (isset($this->TerritoryID)) $o['TerritoryID'] = $this->TerritoryID;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

<RoutePlanPropertyCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Acreage>String</Acreage>
  <Dow>0</Dow>
  <EquipmentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </EquipmentIDs>
  <Minutes>0</Minutes>
  <Name>String</Name>
  <Profile>String</Profile>
  <TerritoryID>0</TerritoryID>
</RoutePlanPropertyCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RoutePlanPropertyCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementID>0</AgreementID>
  <ProjectID>0</ProjectID>
  <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>
</RoutePlanPropertyCreateResponse>