| GET | /api/SaleInfo |
|---|
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 DiscountFromPriceLevel:
base_price_level: Optional[str] = None
disount_percentage: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringSaleDay:
weekday: Optional[str] = None
begin_hour: int = 0
begin_minute: int = 0
end_hour: int = 0
end_minute: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringSaleInfo:
days: Optional[List[RecurringSaleDay]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaleRecord:
sad_pk: int = 0
sku_pk: int = 0
saq_pk: int = 0
model: Optional[str] = None
sku: Optional[str] = None
location_id: int = 0
start_date: datetime.datetime = datetime.datetime(1, 1, 1)
end_date: datetime.datetime = datetime.datetime(1, 1, 1)
customer_account: Optional[int] = None
customer_default_id: Optional[int] = None
condition: Optional[str] = None
discount_from_price_level: Optional[DiscountFromPriceLevel] = None
discount_by_price_level: Optional[str] = None
discount_by_set_price: Optional[Decimal] = None
discount_by_amount: Optional[Decimal] = None
recurring_sale: Optional[RecurringSaleInfo] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaleInfoResponse(BaseResponse):
sale_records: Optional[List[SaleRecord]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaleInfoRequest(BaseSecureRequest):
"""
SaleInfoRequires active-e Inventory Service
"""
location_id: Optional[int] = None
# @ApiMember(Description="If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used", Name="DateTime")
date_time: Optional[datetime.datetime] = None
"""
If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used
"""
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/SaleInfo HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaleInfoResponse 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>
<SaleRecords>
<SaleRecord>
<Condition>String</Condition>
<CustomerAccount>0</CustomerAccount>
<CustomerDefaultId>0</CustomerDefaultId>
<DiscountByAmount>0</DiscountByAmount>
<DiscountByPriceLevel>String</DiscountByPriceLevel>
<DiscountBySetPrice>0</DiscountBySetPrice>
<DiscountFromPriceLevel>
<BasePriceLevel>String</BasePriceLevel>
<DisountPercentage>0</DisountPercentage>
</DiscountFromPriceLevel>
<EndDate>0001-01-01T00:00:00</EndDate>
<LocationId>0</LocationId>
<Model>String</Model>
<RecurringSale>
<Days>
<RecurringSaleDay>
<BeginHour>0</BeginHour>
<BeginMinute>0</BeginMinute>
<EndHour>0</EndHour>
<EndMinute>0</EndMinute>
<Weekday>String</Weekday>
</RecurringSaleDay>
</Days>
</RecurringSale>
<SKU>String</SKU>
<SadPk>0</SadPk>
<SaqPk>0</SaqPk>
<SkuPk>0</SkuPk>
<StartDate>0001-01-01T00:00:00</StartDate>
</SaleRecord>
</SaleRecords>
</SaleInfoResponse>