| GET | /api/ShortTermRentalInventory |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
# @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
api_key: Optional[str] = None
"""
This is your AIM API Key provided by Tri-Tech
"""
# @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
o_auth_token: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
# @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
token: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
app_id: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
# @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
status_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
login: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
error_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
error_display_text: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
error_message: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
domain_name: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
ip_address: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
# @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
status: Optional[BaseResponseResult] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalInventoryRate:
header_desc: Optional[str] = None
header_notes: Optional[str] = None
desc: Optional[str] = None
interval_type: Optional[str] = None
group: Optional[str] = None
notes: Optional[str] = None
amt: Decimal = decimal.Decimal(0)
time_interval: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalInventoryObj:
rates: Optional[List[ShortTermRentalInventoryRate]] = None
available_serial_pks: Optional[List[int]] = None
saq_pk: Optional[int] = None
sku_pk: Optional[int] = None
pkh_pk: Optional[int] = None
sku: Optional[str] = None
package: Optional[str] = None
inv_type: Optional[str] = None
available_qty: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalInventoryResponse(BaseResponse):
results: Optional[List[ShortTermRentalInventoryObj]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalInventoryRequest(BaseSecureRequest):
"""
ShortTermRentalInventoryRequires active-e Short Term Rental Service
"""
# @ApiMember(Description="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name="Item", ParameterType="query")
item: Optional[str] = None
"""
Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory
"""
location_code: Optional[str] = None
# @ApiMember(Description="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name="ItemPk", ParameterType="query")
item_pk: Optional[int] = None
"""
Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory
"""
# @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")
pk_type: Optional[str] = None
"""
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
"""
# @ApiMember(Description="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name="Category", ParameterType="query")
category: Optional[int] = None
"""
Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType
"""
# @ApiMember(Description="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name="SubCategory", ParameterType="query")
sub_category: Optional[int] = None
"""
Pass in either Category + this *OR* Item *OR* ItemPk + PkType
"""
Python 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>