Trendsic Platform Service

<back to all web services

DispatchPatternRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/pattern
<?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 DispatchModuleView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Key=null,
        /** @var string|null */
        public ?string $Mode=null,
        /** @var bool|null */
        public ?bool $Allowed=null,
        /** @var bool|null */
        public ?bool $Enabled=null,
        /** @var int */
        public int $InFlight=0
    ) {
    }

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

class DispatchPatternView implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PatternId=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Source=null,
        /** @var string|null */
        public ?string $Facility=null,
        /** @var string|null */
        public ?string $Unit=null,
        /** @var bool|null */
        public ?bool $HasQuotas=null,
        /** @var bool|null */
        public ?bool $IsInverted=null,
        /** @var int */
        public int $LoadLimitMins=0,
        /** @var string|null */
        public ?string $TicketSource=null,
        /** @var string|null */
        public ?string $PayBasis=null,
        /** @var bool|null */
        public ?bool $IsActive=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PatternId'])) $this->PatternId = $o['PatternId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Source'])) $this->Source = $o['Source'];
        if (isset($o['Facility'])) $this->Facility = $o['Facility'];
        if (isset($o['Unit'])) $this->Unit = $o['Unit'];
        if (isset($o['HasQuotas'])) $this->HasQuotas = $o['HasQuotas'];
        if (isset($o['IsInverted'])) $this->IsInverted = $o['IsInverted'];
        if (isset($o['LoadLimitMins'])) $this->LoadLimitMins = $o['LoadLimitMins'];
        if (isset($o['TicketSource'])) $this->TicketSource = $o['TicketSource'];
        if (isset($o['PayBasis'])) $this->PayBasis = $o['PayBasis'];
        if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PatternId)) $o['PatternId'] = $this->PatternId;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Source)) $o['Source'] = $this->Source;
        if (isset($this->Facility)) $o['Facility'] = $this->Facility;
        if (isset($this->Unit)) $o['Unit'] = $this->Unit;
        if (isset($this->HasQuotas)) $o['HasQuotas'] = $this->HasQuotas;
        if (isset($this->IsInverted)) $o['IsInverted'] = $this->IsInverted;
        if (isset($this->LoadLimitMins)) $o['LoadLimitMins'] = $this->LoadLimitMins;
        if (isset($this->TicketSource)) $o['TicketSource'] = $this->TicketSource;
        if (isset($this->PayBasis)) $o['PayBasis'] = $this->PayBasis;
        if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
        return empty($o) ? new class(){} : $o;
    }
}

class DispatchModulesResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<DispatchModuleView>|null */
        public ?array $Modules=null,
        /** @var array<DispatchPatternView>|null */
        public ?array $Patterns=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class DispatchPatternRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PatternId=null
    ) {
    }

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

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

PUT /v1/dispatch/settings/pattern HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchPatternRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PatternId>String</PatternId>
</DispatchPatternRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchModulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Modules>
    <DispatchModuleView>
      <Allowed>false</Allowed>
      <Enabled>false</Enabled>
      <InFlight>0</InFlight>
      <Key>String</Key>
      <Mode>String</Mode>
    </DispatchModuleView>
  </Modules>
  <Patterns>
    <DispatchPatternView>
      <Facility>String</Facility>
      <HasQuotas>false</HasQuotas>
      <IsActive>false</IsActive>
      <IsInverted>false</IsInverted>
      <LoadLimitMins>0</LoadLimitMins>
      <Name>String</Name>
      <PatternId>String</PatternId>
      <PayBasis>String</PayBasis>
      <Source>String</Source>
      <TicketSource>String</TicketSource>
      <Unit>String</Unit>
    </DispatchPatternView>
  </Patterns>
  <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>
</DispatchModulesResponse>