digitaluapi

SchedulesEdit

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
PUT	/schedules/{Id}

<?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 SchedulesEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $IntervalsId=0,

        // @DataMember(Order=4)
        /** @var DateTime|null */
        public ?DateTime $RunAt=null,

        // @DataMember(Order=5)
        /** @var bool|null */
        public ?bool $Monday=null,

        // @DataMember(Order=6)
        /** @var bool|null */
        public ?bool $Tuesday=null,

        // @DataMember(Order=7)
        /** @var bool|null */
        public ?bool $Wednesday=null,

        // @DataMember(Order=8)
        /** @var bool|null */
        public ?bool $Thursday=null,

        // @DataMember(Order=9)
        /** @var bool|null */
        public ?bool $Friday=null,

        // @DataMember(Order=10)
        /** @var bool|null */
        public ?bool $Saturday=null,

        // @DataMember(Order=11)
        /** @var bool|null */
        public ?bool $Sunday=null,

        // @DataMember(Order=12)
        /** @var int|null */
        public ?int $DayOfMonth=null,

        // @DataMember(Order=13)
        /** @var int|null */
        public ?int $MonthOfYear=null,

        // @DataMember(Order=14)
        /** @var DateTime */
        public DateTime $StartDate=new DateTime(),

        // @DataMember(Order=15)
        /** @var DateTime */
        public DateTime $EndDate=new DateTime(),

        // @DataMember(Order=16)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['IntervalsId'])) $this->IntervalsId = $o['IntervalsId'];
        if (isset($o['RunAt'])) $this->RunAt = JsonConverters::from('DateTime', $o['RunAt']);
        if (isset($o['Monday'])) $this->Monday = $o['Monday'];
        if (isset($o['Tuesday'])) $this->Tuesday = $o['Tuesday'];
        if (isset($o['Wednesday'])) $this->Wednesday = $o['Wednesday'];
        if (isset($o['Thursday'])) $this->Thursday = $o['Thursday'];
        if (isset($o['Friday'])) $this->Friday = $o['Friday'];
        if (isset($o['Saturday'])) $this->Saturday = $o['Saturday'];
        if (isset($o['Sunday'])) $this->Sunday = $o['Sunday'];
        if (isset($o['DayOfMonth'])) $this->DayOfMonth = $o['DayOfMonth'];
        if (isset($o['MonthOfYear'])) $this->MonthOfYear = $o['MonthOfYear'];
        if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
        if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->IntervalsId)) $o['IntervalsId'] = $this->IntervalsId;
        if (isset($this->RunAt)) $o['RunAt'] = JsonConverters::to('DateTime', $this->RunAt);
        if (isset($this->Monday)) $o['Monday'] = $this->Monday;
        if (isset($this->Tuesday)) $o['Tuesday'] = $this->Tuesday;
        if (isset($this->Wednesday)) $o['Wednesday'] = $this->Wednesday;
        if (isset($this->Thursday)) $o['Thursday'] = $this->Thursday;
        if (isset($this->Friday)) $o['Friday'] = $this->Friday;
        if (isset($this->Saturday)) $o['Saturday'] = $this->Saturday;
        if (isset($this->Sunday)) $o['Sunday'] = $this->Sunday;
        if (isset($this->DayOfMonth)) $o['DayOfMonth'] = $this->DayOfMonth;
        if (isset($this->MonthOfYear)) $o['MonthOfYear'] = $this->MonthOfYear;
        if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
        if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class SchedulesEdit implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $IntervalsId=0,

        // @DataMember(Order=4)
        /** @var DateTime|null */
        public ?DateTime $RunAt=null,

        // @DataMember(Order=5)
        /** @var bool|null */
        public ?bool $Monday=null,

        // @DataMember(Order=6)
        /** @var bool|null */
        public ?bool $Tuesday=null,

        // @DataMember(Order=7)
        /** @var bool|null */
        public ?bool $Wednesday=null,

        // @DataMember(Order=8)
        /** @var bool|null */
        public ?bool $Thursday=null,

        // @DataMember(Order=9)
        /** @var bool|null */
        public ?bool $Friday=null,

        // @DataMember(Order=10)
        /** @var bool|null */
        public ?bool $Saturday=null,

        // @DataMember(Order=11)
        /** @var bool|null */
        public ?bool $Sunday=null,

        // @DataMember(Order=12)
        /** @var int|null */
        public ?int $DayOfMonth=null,

        // @DataMember(Order=13)
        /** @var int|null */
        public ?int $MonthOfYear=null,

        // @DataMember(Order=14)
        /** @var DateTime */
        public DateTime $StartDate=new DateTime(),

        // @DataMember(Order=15)
        /** @var DateTime */
        public DateTime $EndDate=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['IntervalsId'])) $this->IntervalsId = $o['IntervalsId'];
        if (isset($o['RunAt'])) $this->RunAt = JsonConverters::from('DateTime', $o['RunAt']);
        if (isset($o['Monday'])) $this->Monday = $o['Monday'];
        if (isset($o['Tuesday'])) $this->Tuesday = $o['Tuesday'];
        if (isset($o['Wednesday'])) $this->Wednesday = $o['Wednesday'];
        if (isset($o['Thursday'])) $this->Thursday = $o['Thursday'];
        if (isset($o['Friday'])) $this->Friday = $o['Friday'];
        if (isset($o['Saturday'])) $this->Saturday = $o['Saturday'];
        if (isset($o['Sunday'])) $this->Sunday = $o['Sunday'];
        if (isset($o['DayOfMonth'])) $this->DayOfMonth = $o['DayOfMonth'];
        if (isset($o['MonthOfYear'])) $this->MonthOfYear = $o['MonthOfYear'];
        if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
        if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->IntervalsId)) $o['IntervalsId'] = $this->IntervalsId;
        if (isset($this->RunAt)) $o['RunAt'] = JsonConverters::to('DateTime', $this->RunAt);
        if (isset($this->Monday)) $o['Monday'] = $this->Monday;
        if (isset($this->Tuesday)) $o['Tuesday'] = $this->Tuesday;
        if (isset($this->Wednesday)) $o['Wednesday'] = $this->Wednesday;
        if (isset($this->Thursday)) $o['Thursday'] = $this->Thursday;
        if (isset($this->Friday)) $o['Friday'] = $this->Friday;
        if (isset($this->Saturday)) $o['Saturday'] = $this->Saturday;
        if (isset($this->Sunday)) $o['Sunday'] = $this->Sunday;
        if (isset($this->DayOfMonth)) $o['DayOfMonth'] = $this->DayOfMonth;
        if (isset($this->MonthOfYear)) $o['MonthOfYear'] = $this->MonthOfYear;
        if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
        if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
        return empty($o) ? new class(){} : $o;
    }
}

PHP SchedulesEdit 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 /schedules/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SchedulesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <IntervalsId>0</IntervalsId>
  <RunAt>0001-01-01T00:00:00</RunAt>
  <Monday>false</Monday>
  <Tuesday>false</Tuesday>
  <Wednesday>false</Wednesday>
  <Thursday>false</Thursday>
  <Friday>false</Friday>
  <Saturday>false</Saturday>
  <Sunday>false</Sunday>
  <DayOfMonth>0</DayOfMonth>
  <MonthOfYear>0</MonthOfYear>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <EndDate>0001-01-01T00:00:00</EndDate>
</SchedulesEdit>

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

<SchedulesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <DayOfMonth>0</DayOfMonth>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Friday>false</Friday>
  <Id>0</Id>
  <IntervalsId>0</IntervalsId>
  <Monday>false</Monday>
  <MonthOfYear>0</MonthOfYear>
  <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>
  <RunAt>0001-01-01T00:00:00</RunAt>
  <Saturday>false</Saturday>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Sunday>false</Sunday>
  <TenantsId>0</TenantsId>
  <Thursday>false</Thursday>
  <Tuesday>false</Tuesday>
  <Wednesday>false</Wednesday>
</SchedulesEditResponse>