| POST | /api/ShortTermRentalReservation |
|---|
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 ShortTermRentalReservationResponse(BaseResponse):
ref_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PackageVariantItem:
model: Optional[str] = None
sku: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalItem:
# @ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")
pk: int = 0
"""
SasPk, SaqPk, or PkhPk
"""
# @ApiMember(Description="S for SerialNumber, P for Package deal. Empty for normal inventory.", Name="ItemType", ParameterType="query")
item_type: Optional[str] = None
"""
S for SerialNumber, P for Package deal. Empty for normal inventory.
"""
# @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", Name="ItemQuantity", ParameterType="query")
item_quantity: Optional[Decimal] = None
"""
Quantity of item required. Does not apply to serial#s.
"""
# @ApiMember(Description="Item rate. This is per item, so the total is this multiplied by ItemQuantity.", IsRequired=true, Name="ItemRate", ParameterType="query")
item_rate: Optional[Decimal] = None
"""
Item rate. This is per item, so the total is this multiplied by ItemQuantity.
"""
notes: Optional[str] = None
package_variant_items: Optional[List[PackageVariantItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ShortTermRentalReservationRequest(BaseSecureRequest):
"""
ShortTermRentalReservationRequires active-e Short Term Rental Service
"""
# @ApiMember(Description="Date/Time the item is to be picked up.", IsRequired=true, Name="PickupDate", ParameterType="query")
pickup_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date/Time the item is to be picked up.
"""
# @ApiMember(Description="Date/Time the item is to be returned.", IsRequired=true, Name="ReturnDate", ParameterType="query")
return_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date/Time the item is to be returned.
"""
# @ApiMember(Description="Account of the customer making the reservation", IsRequired=true, Name="CustomerAcct", ParameterType="query")
customer_acct: int = 0
"""
Account of the customer making the reservation
"""
items: Optional[List[ShortTermRentalItem]] = None
notes: Optional[str] = None
Python ShortTermRentalReservationRequest 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.
POST /api/ShortTermRentalReservation HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShortTermRentalReservationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<CustomerAcct>0</CustomerAcct>
<Items>
<ShortTermRentalItem>
<ItemQuantity>0</ItemQuantity>
<ItemRate>0</ItemRate>
<ItemType>String</ItemType>
<Notes>String</Notes>
<PackageVariantItems>
<PackageVariantItem>
<Model>String</Model>
<Sku>String</Sku>
</PackageVariantItem>
</PackageVariantItems>
<Pk>0</Pk>
</ShortTermRentalItem>
</Items>
<Notes>String</Notes>
<PickupDate>0001-01-01T00:00:00</PickupDate>
<ReturnDate>0001-01-01T00:00:00</ReturnDate>
</ShortTermRentalReservationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalReservationResponse 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>
<RefNumber>String</RefNumber>
</ShortTermRentalReservationResponse>