AIM Web Services

<back to all web services

GetTeeSlotsRequest

GetTeeSlots
Requires active-e Tee-Sheet Service

The following routes are available for this service:
POST, GET/api/GetTeeSlots
<?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};


// @DataContract
class BaseRequest implements JsonSerializable
{
    public function __construct(
        /** @description This is your AIM API Key provided by Tri-Tech */
        // @DataMember
        // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        /** @var string */
        public string $ApiKey='',

        // @DataMember
        // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        /** @var string|null */
        public ?string $OAuthToken=null
    ) {
    }

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

// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        /** @var string|null */
        public ?string $Token=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

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

// @DataContract
class BaseResponseResult implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        /** @var string|null */
        public ?string $StatusCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        /** @var string|null */
        public ?string $Login=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorDisplayText=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorMessage=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        /** @var string|null */
        public ?string $DomainName=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        /** @var string|null */
        public ?string $IpAddress=null
    ) {
    }

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

// @DataContract
class BaseResponse implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        /** @var BaseResponseResult|null */
        public ?BaseResponseResult $Status=null
    ) {
    }

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

// @DataContract
class TeeSlotGeneric implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Id=0,

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

        // @DataMember
        /** @var float */
        public float $Cost=0.0,

        // @DataMember
        /** @var float */
        public float $Cost2=0.0,

        // @DataMember
        /** @var float */
        public float $Cost3=0.0,

        // @DataMember
        /** @var int */
        public int $SlotsOpen=0,

        // @DataMember
        /** @var int */
        public int $MinSlots=0,

        // @DataMember
        /** @var string|null */
        public ?string $Course=null,

        // @DataMember
        /** @var string|null */
        public ?string $CourseTopic=null,

        // @DataMember
        /** @var string|null */
        public ?string $Location=null,

        // @DataMember
        /** @var string|null */
        public ?string $Note=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $Has18Holes=null,

        // @DataMember
        /** @var string|null */
        public ?string $WebId=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $StartingOnBack9=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['DateTime'])) $this->DateTime = JsonConverters::from('DateTime', $o['DateTime']);
        if (isset($o['Cost'])) $this->Cost = $o['Cost'];
        if (isset($o['Cost2'])) $this->Cost2 = $o['Cost2'];
        if (isset($o['Cost3'])) $this->Cost3 = $o['Cost3'];
        if (isset($o['SlotsOpen'])) $this->SlotsOpen = $o['SlotsOpen'];
        if (isset($o['MinSlots'])) $this->MinSlots = $o['MinSlots'];
        if (isset($o['Course'])) $this->Course = $o['Course'];
        if (isset($o['CourseTopic'])) $this->CourseTopic = $o['CourseTopic'];
        if (isset($o['Location'])) $this->Location = $o['Location'];
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['Has18Holes'])) $this->Has18Holes = $o['Has18Holes'];
        if (isset($o['WebId'])) $this->WebId = $o['WebId'];
        if (isset($o['StartingOnBack9'])) $this->StartingOnBack9 = $o['StartingOnBack9'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->DateTime)) $o['DateTime'] = JsonConverters::to('DateTime', $this->DateTime);
        if (isset($this->Cost)) $o['Cost'] = $this->Cost;
        if (isset($this->Cost2)) $o['Cost2'] = $this->Cost2;
        if (isset($this->Cost3)) $o['Cost3'] = $this->Cost3;
        if (isset($this->SlotsOpen)) $o['SlotsOpen'] = $this->SlotsOpen;
        if (isset($this->MinSlots)) $o['MinSlots'] = $this->MinSlots;
        if (isset($this->Course)) $o['Course'] = $this->Course;
        if (isset($this->CourseTopic)) $o['CourseTopic'] = $this->CourseTopic;
        if (isset($this->Location)) $o['Location'] = $this->Location;
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->Has18Holes)) $o['Has18Holes'] = $this->Has18Holes;
        if (isset($this->WebId)) $o['WebId'] = $this->WebId;
        if (isset($this->StartingOnBack9)) $o['StartingOnBack9'] = $this->StartingOnBack9;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetTeeSlotsResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null,
        // @DataMember
        /** @var array<TeeSlotGeneric>|null */
        public ?array $TeeSlots=null
    ) {
        parent::__construct($Status);
    }

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

/** @description GetTeeSlotsRequires active-e Tee-Sheet Service */
// @DataContract
class GetTeeSlotsRequest extends BaseSecureRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     * @param string|null $Token
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        ?string $Token=null,
        ?string $DeviceId=null,
        string $AppId='',
        // @DataMember
        /** @var DateTime */
        public DateTime $DateFrom=new DateTime(),

        // @DataMember
        /** @var DateTime */
        public DateTime $DateTo=new DateTime(),

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $TimeFrom=null,

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $TimeTo=null,

        // @DataMember
        /** @var string|null */
        public ?string $Course=null,

        // @DataMember
        /** @var string|null */
        public ?string $Location=null,

        // @DataMember
        /** @var string|null */
        public ?string $WebId=null,

        // @DataMember
        /** @var int|null */
        public ?int $SlotsRequired=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ShowOpenSlots=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ShowReservedSlots=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $Show9HoleSlots=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $Show18HoleSlots=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ShowFront9=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $ShowBack9=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['DateFrom'])) $this->DateFrom = JsonConverters::from('DateTime', $o['DateFrom']);
        if (isset($o['DateTo'])) $this->DateTo = JsonConverters::from('DateTime', $o['DateTo']);
        if (isset($o['TimeFrom'])) $this->TimeFrom = JsonConverters::from('DateTime', $o['TimeFrom']);
        if (isset($o['TimeTo'])) $this->TimeTo = JsonConverters::from('DateTime', $o['TimeTo']);
        if (isset($o['Course'])) $this->Course = $o['Course'];
        if (isset($o['Location'])) $this->Location = $o['Location'];
        if (isset($o['WebId'])) $this->WebId = $o['WebId'];
        if (isset($o['SlotsRequired'])) $this->SlotsRequired = $o['SlotsRequired'];
        if (isset($o['ShowOpenSlots'])) $this->ShowOpenSlots = $o['ShowOpenSlots'];
        if (isset($o['ShowReservedSlots'])) $this->ShowReservedSlots = $o['ShowReservedSlots'];
        if (isset($o['Show9HoleSlots'])) $this->Show9HoleSlots = $o['Show9HoleSlots'];
        if (isset($o['Show18HoleSlots'])) $this->Show18HoleSlots = $o['Show18HoleSlots'];
        if (isset($o['ShowFront9'])) $this->ShowFront9 = $o['ShowFront9'];
        if (isset($o['ShowBack9'])) $this->ShowBack9 = $o['ShowBack9'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->DateFrom)) $o['DateFrom'] = JsonConverters::to('DateTime', $this->DateFrom);
        if (isset($this->DateTo)) $o['DateTo'] = JsonConverters::to('DateTime', $this->DateTo);
        if (isset($this->TimeFrom)) $o['TimeFrom'] = JsonConverters::to('DateTime', $this->TimeFrom);
        if (isset($this->TimeTo)) $o['TimeTo'] = JsonConverters::to('DateTime', $this->TimeTo);
        if (isset($this->Course)) $o['Course'] = $this->Course;
        if (isset($this->Location)) $o['Location'] = $this->Location;
        if (isset($this->WebId)) $o['WebId'] = $this->WebId;
        if (isset($this->SlotsRequired)) $o['SlotsRequired'] = $this->SlotsRequired;
        if (isset($this->ShowOpenSlots)) $o['ShowOpenSlots'] = $this->ShowOpenSlots;
        if (isset($this->ShowReservedSlots)) $o['ShowReservedSlots'] = $this->ShowReservedSlots;
        if (isset($this->Show9HoleSlots)) $o['Show9HoleSlots'] = $this->Show9HoleSlots;
        if (isset($this->Show18HoleSlots)) $o['Show18HoleSlots'] = $this->Show18HoleSlots;
        if (isset($this->ShowFront9)) $o['ShowFront9'] = $this->ShowFront9;
        if (isset($this->ShowBack9)) $o['ShowBack9'] = $this->ShowBack9;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetTeeSlotsRequest DTOs

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

HTTP + OTHER

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

POST /api/GetTeeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TimeFrom":"0001-01-01T00:00:00.0000000","TimeTo":"0001-01-01T00:00:00.0000000","Course":"String","Location":"String","WebId":"String","SlotsRequired":0,"ShowOpenSlots":false,"ShowReservedSlots":false,"Show9HoleSlots":false,"Show18HoleSlots":false,"ShowFront9":false,"ShowBack9":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TeeSlots":[{"Id":0,"Cost":0,"Cost2":0,"Cost3":0,"SlotsOpen":0,"MinSlots":0,"Course":"String","CourseTopic":"String","Location":"String","Note":"String","Has18Holes":false,"WebId":"String","StartingOnBack9":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}