| GET | /api/ShortTermRentalInventory |
|---|
<?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 ShortTermRentalInventoryRate implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $HeaderDesc=null,
// @DataMember
/** @var string|null */
public ?string $HeaderNotes=null,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var string|null */
public ?string $IntervalType=null,
// @DataMember
/** @var string|null */
public ?string $Group=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var float */
public float $Amt=0.0,
// @DataMember
/** @var int */
public int $TimeInterval=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['HeaderDesc'])) $this->HeaderDesc = $o['HeaderDesc'];
if (isset($o['HeaderNotes'])) $this->HeaderNotes = $o['HeaderNotes'];
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['IntervalType'])) $this->IntervalType = $o['IntervalType'];
if (isset($o['Group'])) $this->Group = $o['Group'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Amt'])) $this->Amt = $o['Amt'];
if (isset($o['TimeInterval'])) $this->TimeInterval = $o['TimeInterval'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->HeaderDesc)) $o['HeaderDesc'] = $this->HeaderDesc;
if (isset($this->HeaderNotes)) $o['HeaderNotes'] = $this->HeaderNotes;
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->IntervalType)) $o['IntervalType'] = $this->IntervalType;
if (isset($this->Group)) $o['Group'] = $this->Group;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Amt)) $o['Amt'] = $this->Amt;
if (isset($this->TimeInterval)) $o['TimeInterval'] = $this->TimeInterval;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ShortTermRentalInventoryObj implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var array<ShortTermRentalInventoryRate>|null */
public ?array $Rates=null,
// @DataMember
/** @var array<int>|null */
public ?array $AvailableSerialPks=null,
// @DataMember
/** @var int|null */
public ?int $SaqPk=null,
// @DataMember
/** @var int|null */
public ?int $SkuPk=null,
// @DataMember
/** @var int|null */
public ?int $PkhPk=null,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var string|null */
public ?string $Package=null,
// @DataMember
/** @var string|null */
public ?string $InvType=null,
// @DataMember
/** @var float */
public float $AvailableQty=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Rates'])) $this->Rates = JsonConverters::fromArray('ShortTermRentalInventoryRate', $o['Rates']);
if (isset($o['AvailableSerialPks'])) $this->AvailableSerialPks = JsonConverters::fromArray('int', $o['AvailableSerialPks']);
if (isset($o['SaqPk'])) $this->SaqPk = $o['SaqPk'];
if (isset($o['SkuPk'])) $this->SkuPk = $o['SkuPk'];
if (isset($o['PkhPk'])) $this->PkhPk = $o['PkhPk'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Package'])) $this->Package = $o['Package'];
if (isset($o['InvType'])) $this->InvType = $o['InvType'];
if (isset($o['AvailableQty'])) $this->AvailableQty = $o['AvailableQty'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Rates)) $o['Rates'] = JsonConverters::toArray('ShortTermRentalInventoryRate', $this->Rates);
if (isset($this->AvailableSerialPks)) $o['AvailableSerialPks'] = JsonConverters::toArray('int', $this->AvailableSerialPks);
if (isset($this->SaqPk)) $o['SaqPk'] = $this->SaqPk;
if (isset($this->SkuPk)) $o['SkuPk'] = $this->SkuPk;
if (isset($this->PkhPk)) $o['PkhPk'] = $this->PkhPk;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Package)) $o['Package'] = $this->Package;
if (isset($this->InvType)) $o['InvType'] = $this->InvType;
if (isset($this->AvailableQty)) $o['AvailableQty'] = $this->AvailableQty;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class ShortTermRentalInventoryResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<ShortTermRentalInventoryObj>|null */
public ?array $Results=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('ShortTermRentalInventoryObj', $o['Results']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('ShortTermRentalInventoryObj', $this->Results);
return empty($o) ? new class(){} : $o;
}
}
/** @description ShortTermRentalInventoryRequires active-e Short Term Rental Service */
// @DataContract
class ShortTermRentalInventoryRequest 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 Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory */
// @DataMember
// @ApiMember(Description="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name="Item", ParameterType="query")
/** @var string|null */
public ?string $Item=null,
// @DataMember
/** @var string|null */
public ?string $LocationCode=null,
/** @description Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory */
// @DataMember
// @ApiMember(Description="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name="ItemPk", ParameterType="query")
/** @var int|null */
public ?int $ItemPk=null,
/** @description Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory */
// @DataMember
// @ApiMember(Description="Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory", Name="PkType", ParameterType="query")
/** @var string|null */
public ?string $PkType=null,
/** @description Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType */
// @DataMember
// @ApiMember(Description="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name="Category", ParameterType="query")
/** @var int|null */
public ?int $Category=null,
/** @description Pass in either Category + this *OR* Item *OR* ItemPk + PkType */
// @DataMember
// @ApiMember(Description="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name="SubCategory", ParameterType="query")
/** @var int|null */
public ?int $SubCategory=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Item'])) $this->Item = $o['Item'];
if (isset($o['LocationCode'])) $this->LocationCode = $o['LocationCode'];
if (isset($o['ItemPk'])) $this->ItemPk = $o['ItemPk'];
if (isset($o['PkType'])) $this->PkType = $o['PkType'];
if (isset($o['Category'])) $this->Category = $o['Category'];
if (isset($o['SubCategory'])) $this->SubCategory = $o['SubCategory'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Item)) $o['Item'] = $this->Item;
if (isset($this->LocationCode)) $o['LocationCode'] = $this->LocationCode;
if (isset($this->ItemPk)) $o['ItemPk'] = $this->ItemPk;
if (isset($this->PkType)) $o['PkType'] = $this->PkType;
if (isset($this->Category)) $o['Category'] = $this->Category;
if (isset($this->SubCategory)) $o['SubCategory'] = $this->SubCategory;
return empty($o) ? new class(){} : $o;
}
}
PHP ShortTermRentalInventoryRequest 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/ShortTermRentalInventory HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalInventoryResponse 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>
<Results>
<ShortTermRentalInventoryObj>
<AvailableQty>0</AvailableQty>
<AvailableSerialPks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>0</d4p1:long>
</AvailableSerialPks>
<InvType>String</InvType>
<Package>String</Package>
<PkhPk>0</PkhPk>
<Rates>
<ShortTermRentalInventoryRate>
<Amt>0</Amt>
<Desc>String</Desc>
<Group>String</Group>
<HeaderDesc>String</HeaderDesc>
<HeaderNotes>String</HeaderNotes>
<IntervalType>String</IntervalType>
<Notes>String</Notes>
<TimeInterval>0</TimeInterval>
</ShortTermRentalInventoryRate>
</Rates>
<SaqPk>0</SaqPk>
<Sku>String</Sku>
<SkuPk>0</SkuPk>
</ShortTermRentalInventoryObj>
</Results>
</ShortTermRentalInventoryResponse>