Trendsic Platform Service

AgreementNeedsSetRequest

The following routes are available for this service:
POST,OPTIONS	/v1/territory/agreementneeds

<?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 Territory implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $TerritoryID=0,
        /** @var string|null */
        public ?string $TerritoryUID=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Color=null,
        /** @var string|null */
        public ?string $ZipCsv=null,
        /** @var int|null */
        public ?int $CrewID=null,
        /** @var string|null */
        public ?string $CrewName=null,
        /** @var bool|null */
        public ?bool $Active=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TerritoryID'])) $this->TerritoryID = $o['TerritoryID'];
        if (isset($o['TerritoryUID'])) $this->TerritoryUID = $o['TerritoryUID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['ZipCsv'])) $this->ZipCsv = $o['ZipCsv'];
        if (isset($o['CrewID'])) $this->CrewID = $o['CrewID'];
        if (isset($o['CrewName'])) $this->CrewName = $o['CrewName'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TerritoryID)) $o['TerritoryID'] = $this->TerritoryID;
        if (isset($this->TerritoryUID)) $o['TerritoryUID'] = $this->TerritoryUID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->ZipCsv)) $o['ZipCsv'] = $this->ZipCsv;
        if (isset($this->CrewID)) $o['CrewID'] = $this->CrewID;
        if (isset($this->CrewName)) $o['CrewName'] = $this->CrewName;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        return empty($o) ? new class(){} : $o;
    }
}

class TerritoryPropertyRow implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $TerritoryID=0,
        /** @var int */
        public int $AgreementID=0
    ) {
    }

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

class CrewEquipmentRow implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CrewID=0,
        /** @var int */
        public int $EquipmentID=0,
        /** @var string|null */
        public ?string $EquipmentName=null
    ) {
    }

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

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

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

class TerritoryResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<Territory>|null */
        public ?array $Territories=null,
        /** @var array<TerritoryPropertyRow>|null */
        public ?array $Properties=null,
        /** @var array<CrewEquipmentRow>|null */
        public ?array $CrewEquipment=null,
        /** @var array<AgreementNeedRow>|null */
        public ?array $AgreementNeeds=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Territories'])) $this->Territories = JsonConverters::fromArray('Territory', $o['Territories']);
        if (isset($o['Properties'])) $this->Properties = JsonConverters::fromArray('TerritoryPropertyRow', $o['Properties']);
        if (isset($o['CrewEquipment'])) $this->CrewEquipment = JsonConverters::fromArray('CrewEquipmentRow', $o['CrewEquipment']);
        if (isset($o['AgreementNeeds'])) $this->AgreementNeeds = JsonConverters::fromArray('AgreementNeedRow', $o['AgreementNeeds']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Territories)) $o['Territories'] = JsonConverters::toArray('Territory', $this->Territories);
        if (isset($this->Properties)) $o['Properties'] = JsonConverters::toArray('TerritoryPropertyRow', $this->Properties);
        if (isset($this->CrewEquipment)) $o['CrewEquipment'] = JsonConverters::toArray('CrewEquipmentRow', $this->CrewEquipment);
        if (isset($this->AgreementNeeds)) $o['AgreementNeeds'] = JsonConverters::toArray('AgreementNeedRow', $this->AgreementNeeds);
        return empty($o) ? new class(){} : $o;
    }
}

class AgreementNeedsSetRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgreementID=0,
        /** @var array<int>|null */
        public ?array $EquipmentIDs=null
    ) {
    }

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

PHP AgreementNeedsSetRequest 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/territory/agreementneeds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgreementNeedsSetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementID>0</AgreementID>
  <EquipmentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </EquipmentIDs>
</AgreementNeedsSetRequest>

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

<TerritoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementNeeds>
    <AgreementNeedRow>
      <AgreementID>0</AgreementID>
      <EquipmentID>0</EquipmentID>
      <EquipmentName>String</EquipmentName>
    </AgreementNeedRow>
  </AgreementNeeds>
  <CrewEquipment>
    <CrewEquipmentRow>
      <CrewID>0</CrewID>
      <EquipmentID>0</EquipmentID>
      <EquipmentName>String</EquipmentName>
    </CrewEquipmentRow>
  </CrewEquipment>
  <Properties>
    <TerritoryPropertyRow>
      <AgreementID>0</AgreementID>
      <TerritoryID>0</TerritoryID>
    </TerritoryPropertyRow>
  </Properties>
  <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>
  <Territories>
    <Territory>
      <Active>false</Active>
      <Color>String</Color>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <Name>String</Name>
      <TerritoryID>0</TerritoryID>
      <TerritoryUID>String</TerritoryUID>
      <ZipCsv>String</ZipCsv>
    </Territory>
  </Territories>
</TerritoryResponse>