AIM Web Services

<back to all web services

GetStationGroupsRequest

GetStationGroups
Requires active-e Station Reservations Service

The following routes are available for this service:
GET/api/GetStationGroups
<?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 LocationInfo implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var int */
        public int $Id=0,

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

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

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

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

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

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

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

        // @DataMember
        /** @var int|null */
        public ?int $CashSaleAcct=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Desc'])) $this->Desc = $o['Desc'];
        if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
        if (isset($o['Region'])) $this->Region = $o['Region'];
        if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
        if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
        if (isset($o['InStorePickup'])) $this->InStorePickup = $o['InStorePickup'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['CashSaleAcct'])) $this->CashSaleAcct = $o['CashSaleAcct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Desc)) $o['Desc'] = $this->Desc;
        if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
        if (isset($this->Region)) $o['Region'] = $this->Region;
        if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
        if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
        if (isset($this->InStorePickup)) $o['InStorePickup'] = $this->InStorePickup;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->CashSaleAcct)) $o['CashSaleAcct'] = $this->CashSaleAcct;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class WeekdayInfo implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $Weekday=null,

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

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

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

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

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

        // @DataMember
        /** @var int|null */
        public ?int $CloseMinute=null
    ) {
    }

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

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

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

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

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

// @DataContract
class StationGroupMembershipData implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var array<StationGroupMembershipLevel>|null */
        public ?array $Levels=null
    ) {
    }

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var array<WeekdayInfo>|null */
        public ?array $Weekdays=null,

        // @DataMember
        /** @var StationGroupMembershipData|null */
        public ?StationGroupMembershipData $MembershipData=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['WebDescription'])) $this->WebDescription = $o['WebDescription'];
        if (isset($o['Topic'])) $this->Topic = $o['Topic'];
        if (isset($o['Interval'])) $this->Interval = $o['Interval'];
        if (isset($o['Buffer'])) $this->Buffer = $o['Buffer'];
        if (isset($o['Location'])) $this->Location = JsonConverters::from('LocationInfo', $o['Location']);
        if (isset($o['Yards'])) $this->Yards = $o['Yards'];
        if (isset($o['Weekdays'])) $this->Weekdays = JsonConverters::fromArray('WeekdayInfo', $o['Weekdays']);
        if (isset($o['MembershipData'])) $this->MembershipData = JsonConverters::from('StationGroupMembershipData', $o['MembershipData']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->WebDescription)) $o['WebDescription'] = $this->WebDescription;
        if (isset($this->Topic)) $o['Topic'] = $this->Topic;
        if (isset($this->Interval)) $o['Interval'] = $this->Interval;
        if (isset($this->Buffer)) $o['Buffer'] = $this->Buffer;
        if (isset($this->Location)) $o['Location'] = JsonConverters::to('LocationInfo', $this->Location);
        if (isset($this->Yards)) $o['Yards'] = $this->Yards;
        if (isset($this->Weekdays)) $o['Weekdays'] = JsonConverters::toArray('WeekdayInfo', $this->Weekdays);
        if (isset($this->MembershipData)) $o['MembershipData'] = JsonConverters::to('StationGroupMembershipData', $this->MembershipData);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

/** @description GetStationGroupsRequires active-e Station Reservations Service */
// @DataContract
class GetStationGroupsRequest 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='',
        /** @description If sent, only station groups at the passed location will be returned. */
        // @DataMember
        // @ApiMember(DataType="integer", Description="If sent, only station groups at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
        /** @var int|null */
        public ?int $LocationId=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

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

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

GET /api/GetStationGroups HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"StationGroups":[{"Id":0,"Description":"String","WebDescription":"String","Topic":"String","Interval":0,"Buffer":0,"Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"Yards":0,"Weekdays":[{"Weekday":"String","WeekdayInt":0,"Open":false,"OpenHour":0,"OpenMinute":0,"CloseHour":0,"CloseMinute":0}],"MembershipData":{"Levels":[{"Level":0,"DaysAhead":0,"AllowBooking":false}]}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}