Reservation Station API

<back to all web services

GetFacilitySchedule

Requires Authentication
<?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 ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, JsonSerializable
{
    public function __construct(
        /** @description The API Key required for authentication */
        // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        /** @var string */
        public string $apiKey='',

        /** @description Latitude of the user making this request */
        // @ApiMember(DataType="double", Description="Latitude of the user making this request")
        /** @var float */
        public float $latitude=0.0,

        /** @description Longitude of the user making this request */
        // @ApiMember(DataType="double", Description="Longitude of the user making this request")
        /** @var float */
        public float $longitude=0.0
    ) {
    }

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

class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $heading=null,
        /** @var bool|null */
        public ?bool $wasSuccessful=null,
        /** @var Object|null */
        public ?Object $modelState=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['heading'])) $this->heading = $o['heading'];
        if (isset($o['wasSuccessful'])) $this->wasSuccessful = $o['wasSuccessful'];
        if (isset($o['modelState'])) $this->modelState = JsonConverters::from('Object', $o['modelState']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->heading)) $o['heading'] = $this->heading;
        if (isset($this->wasSuccessful)) $o['wasSuccessful'] = $this->wasSuccessful;
        if (isset($this->modelState)) $o['modelState'] = JsonConverters::to('Object', $this->modelState);
        return empty($o) ? new class(){} : $o;
    }
}

enum SlotStatus : int
{
    case Available = 0;
    case Closed = 1;
    case Booked = 2;
    case UserBooked = 3;
    case GroupBooked = 4;
    case ToBook = 5;
}

class UserCustomFieldData implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $id='',
        /** @var string|null */
        public ?string $value=null,
        /** @var string|null */
        public ?string $name=null,
        /** @var bool|null */
        public ?bool $optional=null
    ) {
    }

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

class GuestData implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $emailAddress=null,
        /** @var string|null */
        public ?string $mobileNumber=null,
        /** @var array<UserCustomFieldData>|null */
        public ?array $userCustomFields=null,
        /** @var bool|null */
        public ?bool $isAlreadyUser=null,
        /** @var int */
        public int $systemUserId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['emailAddress'])) $this->emailAddress = $o['emailAddress'];
        if (isset($o['mobileNumber'])) $this->mobileNumber = $o['mobileNumber'];
        if (isset($o['userCustomFields'])) $this->userCustomFields = JsonConverters::fromArray('UserCustomFieldData', $o['userCustomFields']);
        if (isset($o['isAlreadyUser'])) $this->isAlreadyUser = $o['isAlreadyUser'];
        if (isset($o['systemUserId'])) $this->systemUserId = $o['systemUserId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->emailAddress)) $o['emailAddress'] = $this->emailAddress;
        if (isset($this->mobileNumber)) $o['mobileNumber'] = $this->mobileNumber;
        if (isset($this->userCustomFields)) $o['userCustomFields'] = JsonConverters::toArray('UserCustomFieldData', $this->userCustomFields);
        if (isset($this->isAlreadyUser)) $o['isAlreadyUser'] = $this->isAlreadyUser;
        if (isset($this->systemUserId)) $o['systemUserId'] = $this->systemUserId;
        return empty($o) ? new class(){} : $o;
    }
}

class SlotData implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $start=null,
        /** @var string|null */
        public ?string $end=null,
        /** @var SlotStatus|null */
        public ?SlotStatus $status=null,
        /** @var int */
        public int $bookingId=0,
        /** @var bool|null */
        public ?bool $remindStart=null,
        /** @var bool|null */
        public ?bool $remind30Mins=null,
        /** @var bool|null */
        public ?bool $remind1Hour=null,
        /** @var bool|null */
        public ?bool $remind6Hours=null,
        /** @var bool|null */
        public ?bool $remind12Hours=null,
        /** @var bool|null */
        public ?bool $remind1Day=null,
        /** @var bool|null */
        public ?bool $remind1Week=null,
        /** @var float */
        public float $billableAmount=0.0,
        /** @var string|null */
        public ?string $bookedByName=null,
        /** @var float */
        public float $billableHours=0.0,
        /** @var float */
        public float $slotLength=0.0,
        /** @var GuestData|null */
        public ?GuestData $userData=null,
        /** @var string|null */
        public ?string $extraRequirements=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['status'])) $this->status = JsonConverters::from('SlotStatus', $o['status']);
        if (isset($o['bookingId'])) $this->bookingId = $o['bookingId'];
        if (isset($o['remindStart'])) $this->remindStart = $o['remindStart'];
        if (isset($o['remind30Mins'])) $this->remind30Mins = $o['remind30Mins'];
        if (isset($o['remind1Hour'])) $this->remind1Hour = $o['remind1Hour'];
        if (isset($o['remind6Hours'])) $this->remind6Hours = $o['remind6Hours'];
        if (isset($o['remind12Hours'])) $this->remind12Hours = $o['remind12Hours'];
        if (isset($o['remind1Day'])) $this->remind1Day = $o['remind1Day'];
        if (isset($o['remind1Week'])) $this->remind1Week = $o['remind1Week'];
        if (isset($o['billableAmount'])) $this->billableAmount = $o['billableAmount'];
        if (isset($o['bookedByName'])) $this->bookedByName = $o['bookedByName'];
        if (isset($o['billableHours'])) $this->billableHours = $o['billableHours'];
        if (isset($o['slotLength'])) $this->slotLength = $o['slotLength'];
        if (isset($o['userData'])) $this->userData = JsonConverters::from('GuestData', $o['userData']);
        if (isset($o['extraRequirements'])) $this->extraRequirements = $o['extraRequirements'];
    }
    
    /** @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->status)) $o['status'] = JsonConverters::to('SlotStatus', $this->status);
        if (isset($this->bookingId)) $o['bookingId'] = $this->bookingId;
        if (isset($this->remindStart)) $o['remindStart'] = $this->remindStart;
        if (isset($this->remind30Mins)) $o['remind30Mins'] = $this->remind30Mins;
        if (isset($this->remind1Hour)) $o['remind1Hour'] = $this->remind1Hour;
        if (isset($this->remind6Hours)) $o['remind6Hours'] = $this->remind6Hours;
        if (isset($this->remind12Hours)) $o['remind12Hours'] = $this->remind12Hours;
        if (isset($this->remind1Day)) $o['remind1Day'] = $this->remind1Day;
        if (isset($this->remind1Week)) $o['remind1Week'] = $this->remind1Week;
        if (isset($this->billableAmount)) $o['billableAmount'] = $this->billableAmount;
        if (isset($this->bookedByName)) $o['bookedByName'] = $this->bookedByName;
        if (isset($this->billableHours)) $o['billableHours'] = $this->billableHours;
        if (isset($this->slotLength)) $o['slotLength'] = $this->slotLength;
        if (isset($this->userData)) $o['userData'] = JsonConverters::to('GuestData', $this->userData);
        if (isset($this->extraRequirements)) $o['extraRequirements'] = $this->extraRequirements;
        return empty($o) ? new class(){} : $o;
    }
}

class ScheduleDayData implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $date=null,
        /** @var array<SlotData>|null */
        public ?array $slots=null
    ) {
    }

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

class RatesItem implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $rate=0.0,
        /** @var int */
        public int $minutes=0
    ) {
    }

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

class FacilityData implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $facilityId=0,
        /** @var string|null */
        public ?string $facilityGuid=null,
        /** @var string|null */
        public ?string $name=null,
        /** @var string|null */
        public ?string $description=null,
        /** @var string|null */
        public ?string $nextAvailable=null,
        /** @var bool|null */
        public ?bool $hasNextAvailable=null,
        /** @var array<RatesItem>|null */
        public ?array $rates=null,
        /** @var string|null */
        public ?string $themeColor=null,
        /** @var string|null */
        public ?string $bookingNotes=null,
        /** @var int */
        public int $leadTime=0,
        /** @var int */
        public int $venueId=0,
        /** @var bool|null */
        public ?bool $allowExtraRequirements=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['facilityId'])) $this->facilityId = $o['facilityId'];
        if (isset($o['facilityGuid'])) $this->facilityGuid = $o['facilityGuid'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['nextAvailable'])) $this->nextAvailable = $o['nextAvailable'];
        if (isset($o['hasNextAvailable'])) $this->hasNextAvailable = $o['hasNextAvailable'];
        if (isset($o['rates'])) $this->rates = JsonConverters::fromArray('RatesItem', $o['rates']);
        if (isset($o['themeColor'])) $this->themeColor = $o['themeColor'];
        if (isset($o['bookingNotes'])) $this->bookingNotes = $o['bookingNotes'];
        if (isset($o['leadTime'])) $this->leadTime = $o['leadTime'];
        if (isset($o['venueId'])) $this->venueId = $o['venueId'];
        if (isset($o['allowExtraRequirements'])) $this->allowExtraRequirements = $o['allowExtraRequirements'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->facilityId)) $o['facilityId'] = $this->facilityId;
        if (isset($this->facilityGuid)) $o['facilityGuid'] = $this->facilityGuid;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->nextAvailable)) $o['nextAvailable'] = $this->nextAvailable;
        if (isset($this->hasNextAvailable)) $o['hasNextAvailable'] = $this->hasNextAvailable;
        if (isset($this->rates)) $o['rates'] = JsonConverters::toArray('RatesItem', $this->rates);
        if (isset($this->themeColor)) $o['themeColor'] = $this->themeColor;
        if (isset($this->bookingNotes)) $o['bookingNotes'] = $this->bookingNotes;
        if (isset($this->leadTime)) $o['leadTime'] = $this->leadTime;
        if (isset($this->venueId)) $o['venueId'] = $this->venueId;
        if (isset($this->allowExtraRequirements)) $o['allowExtraRequirements'] = $this->allowExtraRequirements;
        return empty($o) ? new class(){} : $o;
    }
}

class GetFacilityScheduleResponse extends ApiServiceResponse implements JsonSerializable
{
    /**
     * @param string|null $description
     * @param string|null $heading
     * @param bool|null $wasSuccessful
     * @param Object|null $modelState
     */
    public function __construct(
        ?string $description=null,
        ?string $heading=null,
        ?bool $wasSuccessful=null,
        ?Object $modelState=null,
        /** @var array<ScheduleDayData>|null */
        public ?array $schedule=null,
        /** @var string|null */
        public ?string $bookAheadMaxDate=null,
        /** @var int */
        public int $openHour=0,
        /** @var int */
        public int $closeHour=0,
        /** @var int */
        public int $duration=0,
        /** @var bool|null */
        public ?bool $isCoordinator=null,
        /** @var int */
        public int $facilityTimeOffset=0,
        /** @var FacilityData|null */
        public ?FacilityData $facility=null,
        /** @var string|null */
        public ?string $venueName=null,
        /** @var bool|null */
        public ?bool $allowGuests=null,
        /** @var bool|null */
        public ?bool $allowExtraRequirements=null,
        /** @var bool|null */
        public ?bool $allowBookingInProgress=null
    ) {
        parent::__construct($description,$heading,$wasSuccessful,$modelState);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['schedule'])) $this->schedule = JsonConverters::fromArray('ScheduleDayData', $o['schedule']);
        if (isset($o['bookAheadMaxDate'])) $this->bookAheadMaxDate = $o['bookAheadMaxDate'];
        if (isset($o['openHour'])) $this->openHour = $o['openHour'];
        if (isset($o['closeHour'])) $this->closeHour = $o['closeHour'];
        if (isset($o['duration'])) $this->duration = $o['duration'];
        if (isset($o['isCoordinator'])) $this->isCoordinator = $o['isCoordinator'];
        if (isset($o['facilityTimeOffset'])) $this->facilityTimeOffset = $o['facilityTimeOffset'];
        if (isset($o['facility'])) $this->facility = JsonConverters::from('FacilityData', $o['facility']);
        if (isset($o['venueName'])) $this->venueName = $o['venueName'];
        if (isset($o['allowGuests'])) $this->allowGuests = $o['allowGuests'];
        if (isset($o['allowExtraRequirements'])) $this->allowExtraRequirements = $o['allowExtraRequirements'];
        if (isset($o['allowBookingInProgress'])) $this->allowBookingInProgress = $o['allowBookingInProgress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->schedule)) $o['schedule'] = JsonConverters::toArray('ScheduleDayData', $this->schedule);
        if (isset($this->bookAheadMaxDate)) $o['bookAheadMaxDate'] = $this->bookAheadMaxDate;
        if (isset($this->openHour)) $o['openHour'] = $this->openHour;
        if (isset($this->closeHour)) $o['closeHour'] = $this->closeHour;
        if (isset($this->duration)) $o['duration'] = $this->duration;
        if (isset($this->isCoordinator)) $o['isCoordinator'] = $this->isCoordinator;
        if (isset($this->facilityTimeOffset)) $o['facilityTimeOffset'] = $this->facilityTimeOffset;
        if (isset($this->facility)) $o['facility'] = JsonConverters::to('FacilityData', $this->facility);
        if (isset($this->venueName)) $o['venueName'] = $this->venueName;
        if (isset($this->allowGuests)) $o['allowGuests'] = $this->allowGuests;
        if (isset($this->allowExtraRequirements)) $o['allowExtraRequirements'] = $this->allowExtraRequirements;
        if (isset($this->allowBookingInProgress)) $o['allowBookingInProgress'] = $this->allowBookingInProgress;
        return empty($o) ? new class(){} : $o;
    }
}

class GetFacilitySchedule extends ApiServiceRequest implements JsonSerializable
{
    /**
     * @param string $apiKey
     * @param float $latitude
     * @param float $longitude
     */
    public function __construct(
        string $apiKey='',
        float $latitude=0.0,
        float $longitude=0.0,
        /** @var int */
        public int $facilityId=0,
        /** @var DateTime */
        public DateTime $start=new DateTime(),
        /** @var DateTime */
        public DateTime $end=new DateTime()
    ) {
        parent::__construct($apiKey,$latitude,$longitude);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['facilityId'])) $this->facilityId = $o['facilityId'];
        if (isset($o['start'])) $this->start = JsonConverters::from('DateTime', $o['start']);
        if (isset($o['end'])) $this->end = JsonConverters::from('DateTime', $o['end']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->facilityId)) $o['facilityId'] = $this->facilityId;
        if (isset($this->start)) $o['start'] = JsonConverters::to('DateTime', $this->start);
        if (isset($this->end)) $o['end'] = JsonConverters::to('DateTime', $this->end);
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetFacilitySchedule DTOs

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

HTTP + CSV

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

POST /csv/reply/GetFacilitySchedule HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"facilityId":0,"start":"0001-01-01T00:00:00.0000000","end":"0001-01-01T00:00:00.0000000","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"schedule":[{"date":"String","slots":[{"start":"String","end":"String","status":0,"bookingId":0,"remindStart":false,"remind30Mins":false,"remind1Hour":false,"remind6Hours":false,"remind12Hours":false,"remind1Day":false,"remind1Week":false,"billableAmount":0,"bookedByName":"String","billableHours":0,"slotLength":0,"extraRequirements":"String"}]}],"bookAheadMaxDate":"String","openHour":0,"closeHour":0,"duration":0,"isCoordinator":false,"facilityTimeOffset":0,"venueName":"String","allowGuests":false,"allowExtraRequirements":false,"allowBookingInProgress":false,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}