| GET | /api/ShortTermRentalAvailability |
|---|
<?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 AvailableSku implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $SaqPk=0,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var string|null */
public ?string $Description=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SaqPk'])) $this->SaqPk = $o['SaqPk'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Description'])) $this->Description = $o['Description'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SaqPk)) $o['SaqPk'] = $this->SaqPk;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Description)) $o['Description'] = $this->Description;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ShortTermRentalAvailabilityResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var bool|null */
public ?bool $IsAvailable=null,
// @DataMember
/** @var array<AvailableSku>|null */
public ?array $AvailableSkus=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['IsAvailable'])) $this->IsAvailable = $o['IsAvailable'];
if (isset($o['AvailableSkus'])) $this->AvailableSkus = JsonConverters::fromArray('AvailableSku', $o['AvailableSkus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->IsAvailable)) $o['IsAvailable'] = $this->IsAvailable;
if (isset($this->AvailableSkus)) $o['AvailableSkus'] = JsonConverters::toArray('AvailableSku', $this->AvailableSkus);
return empty($o) ? new class(){} : $o;
}
}
/** @description ShortTermRentalAvailabilityRequires active-e Short Term Rental Service */
// @DataContract
class ShortTermRentalAvailabilityRequest 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 Date/Time the item is to be picked up. */
// @DataMember
// @ApiMember(Description="Date/Time the item is to be picked up.", IsRequired=true, Name="PickupDate", ParameterType="query")
/** @var DateTime */
public DateTime $PickupDate=new DateTime(),
/** @description Date/Time the item is to be returned. */
// @DataMember
// @ApiMember(Description="Date/Time the item is to be returned.", IsRequired=true, Name="ReturnDate", ParameterType="query")
/** @var DateTime */
public DateTime $ReturnDate=new DateTime(),
/** @description PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
// @DataMember
// @ApiMember(Description="PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SaqPk", ParameterType="query")
/** @var int|null */
public ?int $SaqPk=null,
/** @description PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
// @DataMember
// @ApiMember(Description="PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SasPk", ParameterType="query")
/** @var int|null */
public ?int $SasPk=null,
/** @description PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
// @DataMember
// @ApiMember(Description="PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="PkhPk", ParameterType="query")
/** @var int|null */
public ?int $PkhPk=null,
/** @description Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
// @DataMember
// @ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="Category", ParameterType="query")
/** @var int|null */
public ?int $Category=null,
/** @description Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
// @DataMember
// @ApiMember(Description="Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory", Name="SubCategory", ParameterType="query")
/** @var int|null */
public ?int $SubCategory=null,
/** @description Quantity of item required. Does not apply to serial#s. */
// @DataMember
// @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", IsRequired=true, Name="ItemQuantity", ParameterType="query")
/** @var float */
public float $ItemQuantity=0.0
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['PickupDate'])) $this->PickupDate = JsonConverters::from('DateTime', $o['PickupDate']);
if (isset($o['ReturnDate'])) $this->ReturnDate = JsonConverters::from('DateTime', $o['ReturnDate']);
if (isset($o['SaqPk'])) $this->SaqPk = $o['SaqPk'];
if (isset($o['SasPk'])) $this->SasPk = $o['SasPk'];
if (isset($o['PkhPk'])) $this->PkhPk = $o['PkhPk'];
if (isset($o['Category'])) $this->Category = $o['Category'];
if (isset($o['SubCategory'])) $this->SubCategory = $o['SubCategory'];
if (isset($o['ItemQuantity'])) $this->ItemQuantity = $o['ItemQuantity'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->PickupDate)) $o['PickupDate'] = JsonConverters::to('DateTime', $this->PickupDate);
if (isset($this->ReturnDate)) $o['ReturnDate'] = JsonConverters::to('DateTime', $this->ReturnDate);
if (isset($this->SaqPk)) $o['SaqPk'] = $this->SaqPk;
if (isset($this->SasPk)) $o['SasPk'] = $this->SasPk;
if (isset($this->PkhPk)) $o['PkhPk'] = $this->PkhPk;
if (isset($this->Category)) $o['Category'] = $this->Category;
if (isset($this->SubCategory)) $o['SubCategory'] = $this->SubCategory;
if (isset($this->ItemQuantity)) $o['ItemQuantity'] = $this->ItemQuantity;
return empty($o) ? new class(){} : $o;
}
}
PHP ShortTermRentalAvailabilityRequest DTOs
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/ShortTermRentalAvailability HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalAvailabilityResponse 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>
<AvailableSkus>
<AvailableSku>
<Description>String</Description>
<SaqPk>0</SaqPk>
<Sku>String</Sku>
</AvailableSku>
</AvailableSkus>
<IsAvailable>false</IsAvailable>
</ShortTermRentalAvailabilityResponse>