| GET | /api/GetStations |
|---|
<?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 ReservationInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var DateTime */
public DateTime $Start=new DateTime(),
// @DataMember
/** @var DateTime */
public DateTime $End=new DateTime(),
// @DataMember
/** @var int|null */
public ?int $CustomerAcct=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Start'])) $this->Start = JsonConverters::from('DateTime', $o['Start']);
if (isset($o['End'])) $this->End = JsonConverters::from('DateTime', $o['End']);
if (isset($o['CustomerAcct'])) $this->CustomerAcct = $o['CustomerAcct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Start)) $o['Start'] = JsonConverters::to('DateTime', $this->Start);
if (isset($this->End)) $o['End'] = JsonConverters::to('DateTime', $this->End);
if (isset($this->CustomerAcct)) $o['CustomerAcct'] = $this->CustomerAcct;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class StationInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $WebDescription=null,
// @DataMember
/** @var int */
public int $MaxUsers=0,
// @DataMember
/** @var LocationInfo|null */
public ?LocationInfo $Location=null,
// @DataMember
/** @var string|null */
public ?string $CurrentStatus=null,
// @DataMember
/** @var array<ReservationInfo>|null */
public ?array $Reservations=null,
// @DataMember
/** @var array<DateTime>|null */
public ?array $AvailabilityCalendar=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['WebDescription'])) $this->WebDescription = $o['WebDescription'];
if (isset($o['MaxUsers'])) $this->MaxUsers = $o['MaxUsers'];
if (isset($o['Location'])) $this->Location = JsonConverters::from('LocationInfo', $o['Location']);
if (isset($o['CurrentStatus'])) $this->CurrentStatus = $o['CurrentStatus'];
if (isset($o['Reservations'])) $this->Reservations = JsonConverters::fromArray('ReservationInfo', $o['Reservations']);
if (isset($o['AvailabilityCalendar'])) $this->AvailabilityCalendar = JsonConverters::fromArray('DateTime', $o['AvailabilityCalendar']);
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->WebDescription)) $o['WebDescription'] = $this->WebDescription;
if (isset($this->MaxUsers)) $o['MaxUsers'] = $this->MaxUsers;
if (isset($this->Location)) $o['Location'] = JsonConverters::to('LocationInfo', $this->Location);
if (isset($this->CurrentStatus)) $o['CurrentStatus'] = $this->CurrentStatus;
if (isset($this->Reservations)) $o['Reservations'] = JsonConverters::toArray('ReservationInfo', $this->Reservations);
if (isset($this->AvailabilityCalendar)) $o['AvailabilityCalendar'] = JsonConverters::toArray('DateTime', $this->AvailabilityCalendar);
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetStationsResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<StationInfo>|null */
public ?array $Stations=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Stations'])) $this->Stations = JsonConverters::fromArray('StationInfo', $o['Stations']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Stations)) $o['Stations'] = JsonConverters::toArray('StationInfo', $this->Stations);
return empty($o) ? new class(){} : $o;
}
}
/** @description GetStationsRequires active-e Station Reservations Service */
// @DataContract
class GetStationsRequest 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 stations at the passed location will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only stations at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
/** @var int|null */
public ?int $LocationId=null,
/** @description If sent, only stations in the passed Station group will be returned */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only stations in the passed Station group will be returned", Format="int64", Name="GroupId", ParameterType="query")
/** @var int|null */
public ?int $GroupId=null,
// @DataMember
/** @var int|null */
public ?int $Acct=null,
// @DataMember
/** @var bool|null */
public ?bool $GenerateAvailabilityCalendar=null,
/** @description If sent, the availability calendar will be for the next X days */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the next X days", Format="int64", Name="AvailabilityCalendarDays", ParameterType="query")
/** @var int|null */
public ?int $AvailabilityCalendarDays=null,
/** @description If sent, the availability calendar will be for the sent date only */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, the availability calendar will be for the sent date only", Format="int64", Name="AvailabilityCalendarDate", ParameterType="query")
/** @var DateTime|null */
public ?DateTime $AvailabilityCalendarDate=null,
/** @description If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent.", Format="int64", Name="AvailabilityCalendarReservationLength", ParameterType="query")
/** @var int|null */
public ?int $AvailabilityCalendarReservationLength=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'];
if (isset($o['GroupId'])) $this->GroupId = $o['GroupId'];
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['GenerateAvailabilityCalendar'])) $this->GenerateAvailabilityCalendar = $o['GenerateAvailabilityCalendar'];
if (isset($o['AvailabilityCalendarDays'])) $this->AvailabilityCalendarDays = $o['AvailabilityCalendarDays'];
if (isset($o['AvailabilityCalendarDate'])) $this->AvailabilityCalendarDate = JsonConverters::from('DateTime', $o['AvailabilityCalendarDate']);
if (isset($o['AvailabilityCalendarReservationLength'])) $this->AvailabilityCalendarReservationLength = $o['AvailabilityCalendarReservationLength'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->GroupId)) $o['GroupId'] = $this->GroupId;
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->GenerateAvailabilityCalendar)) $o['GenerateAvailabilityCalendar'] = $this->GenerateAvailabilityCalendar;
if (isset($this->AvailabilityCalendarDays)) $o['AvailabilityCalendarDays'] = $this->AvailabilityCalendarDays;
if (isset($this->AvailabilityCalendarDate)) $o['AvailabilityCalendarDate'] = JsonConverters::to('DateTime', $this->AvailabilityCalendarDate);
if (isset($this->AvailabilityCalendarReservationLength)) $o['AvailabilityCalendarReservationLength'] = $this->AvailabilityCalendarReservationLength;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetStations HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetStationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<Stations>
<GetStationsResponse.StationInfo>
<AvailabilityCalendar xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:dateTime>0001-01-01T00:00:00</d4p1:dateTime>
</AvailabilityCalendar>
<CurrentStatus>String</CurrentStatus>
<Id>0</Id>
<Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
<d4p1:Active>false</d4p1:Active>
<d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
<d4p1:Desc>String</d4p1:Desc>
<d4p1:Id>0</d4p1:Id>
<d4p1:InStorePickup>String</d4p1:InStorePickup>
<d4p1:Latitude>0</d4p1:Latitude>
<d4p1:Longitude>0</d4p1:Longitude>
<d4p1:Region>String</d4p1:Region>
<d4p1:ShortDesc>String</d4p1:ShortDesc>
</Location>
<MaxUsers>0</MaxUsers>
<Name>String</Name>
<Reservations>
<GetStationsResponse.StationInfo.ReservationInfo>
<CustomerAcct>0</CustomerAcct>
<End>0001-01-01T00:00:00</End>
<Start>0001-01-01T00:00:00</Start>
</GetStationsResponse.StationInfo.ReservationInfo>
</Reservations>
<Topic>String</Topic>
<WebDescription>String</WebDescription>
</GetStationsResponse.StationInfo>
</Stations>
</GetStationsResponse>