Trendsic Platform Service

ShiftPatternArchiveRequest

The following routes are available for this service:
DELETE	/v1/workforce/patterns/{ShiftPatternID}

<?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 ShiftPattern implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ShiftPatternID=0,
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var string|null */
        public ?string $Code=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Struct=null,
        /** @var float */
        public float $HoursPerDay=0.0,
        /** @var int */
        public int $OnDays=0,
        /** @var int */
        public int $OffDays=0,
        /** @var string|null */
        public ?string $PatternType=null,
        /** @var bool|null */
        public ?bool $IsNight=null,
        /** @var bool|null */
        public ?bool $HasBoundary=null,
        /** @var bool|null */
        public ?bool $IsHitch=null,
        /** @var bool|null */
        public ?bool $HasTravel=null,
        /** @var bool|null */
        public ?bool $IsSeasonal=null,
        /** @var string|null */
        public ?string $SeasonalWindow=null,
        /** @var bool|null */
        public ?bool $IsDayRate=null,
        /** @var string|null */
        public ?string $OtRuleId=null,
        /** @var string|null */
        public ?string $PerDiemRuleId=null,
        /** @var string|null */
        public ?string $Packs=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var bool|null */
        public ?bool $IsSeed=null,
        /** @var int */
        public int $AssignedCount=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ShiftPatternID'])) $this->ShiftPatternID = $o['ShiftPatternID'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['Code'])) $this->Code = $o['Code'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Struct'])) $this->Struct = $o['Struct'];
        if (isset($o['HoursPerDay'])) $this->HoursPerDay = $o['HoursPerDay'];
        if (isset($o['OnDays'])) $this->OnDays = $o['OnDays'];
        if (isset($o['OffDays'])) $this->OffDays = $o['OffDays'];
        if (isset($o['PatternType'])) $this->PatternType = $o['PatternType'];
        if (isset($o['IsNight'])) $this->IsNight = $o['IsNight'];
        if (isset($o['HasBoundary'])) $this->HasBoundary = $o['HasBoundary'];
        if (isset($o['IsHitch'])) $this->IsHitch = $o['IsHitch'];
        if (isset($o['HasTravel'])) $this->HasTravel = $o['HasTravel'];
        if (isset($o['IsSeasonal'])) $this->IsSeasonal = $o['IsSeasonal'];
        if (isset($o['SeasonalWindow'])) $this->SeasonalWindow = $o['SeasonalWindow'];
        if (isset($o['IsDayRate'])) $this->IsDayRate = $o['IsDayRate'];
        if (isset($o['OtRuleId'])) $this->OtRuleId = $o['OtRuleId'];
        if (isset($o['PerDiemRuleId'])) $this->PerDiemRuleId = $o['PerDiemRuleId'];
        if (isset($o['Packs'])) $this->Packs = $o['Packs'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['IsSeed'])) $this->IsSeed = $o['IsSeed'];
        if (isset($o['AssignedCount'])) $this->AssignedCount = $o['AssignedCount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ShiftPatternID)) $o['ShiftPatternID'] = $this->ShiftPatternID;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->Code)) $o['Code'] = $this->Code;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Struct)) $o['Struct'] = $this->Struct;
        if (isset($this->HoursPerDay)) $o['HoursPerDay'] = $this->HoursPerDay;
        if (isset($this->OnDays)) $o['OnDays'] = $this->OnDays;
        if (isset($this->OffDays)) $o['OffDays'] = $this->OffDays;
        if (isset($this->PatternType)) $o['PatternType'] = $this->PatternType;
        if (isset($this->IsNight)) $o['IsNight'] = $this->IsNight;
        if (isset($this->HasBoundary)) $o['HasBoundary'] = $this->HasBoundary;
        if (isset($this->IsHitch)) $o['IsHitch'] = $this->IsHitch;
        if (isset($this->HasTravel)) $o['HasTravel'] = $this->HasTravel;
        if (isset($this->IsSeasonal)) $o['IsSeasonal'] = $this->IsSeasonal;
        if (isset($this->SeasonalWindow)) $o['SeasonalWindow'] = $this->SeasonalWindow;
        if (isset($this->IsDayRate)) $o['IsDayRate'] = $this->IsDayRate;
        if (isset($this->OtRuleId)) $o['OtRuleId'] = $this->OtRuleId;
        if (isset($this->PerDiemRuleId)) $o['PerDiemRuleId'] = $this->PerDiemRuleId;
        if (isset($this->Packs)) $o['Packs'] = $this->Packs;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->IsSeed)) $o['IsSeed'] = $this->IsSeed;
        if (isset($this->AssignedCount)) $o['AssignedCount'] = $this->AssignedCount;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ShiftPatternArchiveRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ShiftPatternID=0
    ) {
    }

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

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

DELETE /v1/workforce/patterns/{ShiftPatternID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ShiftPatternsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Patterns>
    <ShiftPattern>
      <AssignedCount>0</AssignedCount>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Code>String</Code>
      <HasBoundary>false</HasBoundary>
      <HasTravel>false</HasTravel>
      <HoursPerDay>0</HoursPerDay>
      <IsDayRate>false</IsDayRate>
      <IsHitch>false</IsHitch>
      <IsNight>false</IsNight>
      <IsSeasonal>false</IsSeasonal>
      <IsSeed>false</IsSeed>
      <Name>String</Name>
      <OffDays>0</OffDays>
      <OnDays>0</OnDays>
      <OtRuleId>String</OtRuleId>
      <Packs>String</Packs>
      <PatternType>String</PatternType>
      <PerDiemRuleId>String</PerDiemRuleId>
      <SeasonalWindow>String</SeasonalWindow>
      <ShiftPatternID>0</ShiftPatternID>
      <Status>String</Status>
      <Struct>String</Struct>
    </ShiftPattern>
  </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>
</ShiftPatternsResponse>