Trendsic Platform Service

CoverageSelfAvailGetRequest

The following routes are available for this service:
GET,OPTIONS	/v1/coverage/self/availability

<?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 CoverageSelfAvailWindow implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Start=null,
        /** @var string|null */
        public ?string $End=null,
        /** @var bool|null */
        public ?bool $Preferred=null
    ) {
    }

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

class CoverageSelfAvailDay implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Day=null,
        /** @var bool|null */
        public ?bool $Open=null,
        /** @var array<CoverageSelfAvailWindow>|null */
        public ?array $Windows=null
    ) {
    }

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

class WorkerSchedulingPrefs implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ContactID=0,
        /** @var int|null */
        public ?int $PreferredWeeklyHours=null,
        /** @var int|null */
        public ?int $PreferredMonthlyHours=null,
        /** @var int|null */
        public ?int $MinShiftMinutes=null,
        /** @var int|null */
        public ?int $MaxConsecutiveDays=null
    ) {
    }

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

class CoverageSelfAvailResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<CoverageSelfAvailDay>|null */
        public ?array $Days=null,
        /** @var WorkerSchedulingPrefs|null */
        public ?WorkerSchedulingPrefs $Prefs=null,
        /** @var string|null */
        public ?string $RulesSummary=null,
        /** @var int */
        public int $TimeOffNoticeDays=0
    ) {
    }

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

class CoverageSelfAvailGetRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP CoverageSelfAvailGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/coverage/self/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Days":[{"Day":"String","Open":false,"Windows":[{"Start":"String","End":"String","Preferred":false}]}],"Prefs":{"ContactID":0,"PreferredWeeklyHours":0,"PreferredMonthlyHours":0,"MinShiftMinutes":0,"MaxConsecutiveDays":0},"RulesSummary":"String","TimeOffNoticeDays":0}