| GET | /api/History360 |
|---|
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 Item360:
pslr_id: Optional[int] = None
quantity: Decimal = decimal.Decimal(0)
price: Decimal = decimal.Decimal(0)
total_discount_amount: Decimal = decimal.Decimal(0)
serial_number: Optional[str] = None
condition: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Invoice360:
id: Optional[str] = None
due_date: Optional[datetime.datetime] = None
total: Decimal = decimal.Decimal(0)
status: Optional[str] = None
amount_paid: Decimal = decimal.Decimal(0)
late_fee_amount: Decimal = decimal.Decimal(0)
purchase_date: datetime.datetime = datetime.datetime(1, 1, 1)
store_location_id: Optional[int] = None
items: Optional[List[Item360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order360:
id: int = 0
date: datetime.datetime = datetime.datetime(1, 1, 1)
discount: Decimal = decimal.Decimal(0)
payment_type: Optional[str] = None
sub_total: Decimal = decimal.Decimal(0)
tax: Decimal = decimal.Decimal(0)
shipping_amount: Decimal = decimal.Decimal(0)
total: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Job360:
item_id: Optional[str] = None
item_type: Optional[str] = None
title: Optional[str] = None
quantity: Decimal = decimal.Decimal(0)
price: Decimal = decimal.Decimal(0)
total_discount_amount: Decimal = decimal.Decimal(0)
serial_number: Optional[str] = None
condition: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkOrder360:
id: Optional[str] = None
status: Optional[str] = None
deposit: Decimal = decimal.Decimal(0)
store_location_id: Optional[int] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
completed_date: Optional[datetime.datetime] = None
price: Decimal = decimal.Decimal(0)
jobs: Optional[List[Job360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contract360:
id: Optional[str] = None
payment_date: datetime.datetime = datetime.datetime(1, 1, 1)
store_location_id: Optional[int] = None
amount_due: Decimal = decimal.Decimal(0)
late_fee: Decimal = decimal.Decimal(0)
contract_status: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
contract_items: Optional[List[Item360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class History360Response(BaseResponse):
invoices: Optional[List[Invoice360]] = None
orders: Optional[List[Order360]] = None
work_orders: Optional[List[WorkOrder360]] = None
contracts: Optional[List[Contract360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class History360Request(BaseSecureRequest):
"""
History360Requires active-e Customer Service.
"""
customer_account: int = 0
include_invoices: bool = False
include_orders: bool = False
include_work_orders: bool = False
include_contracts: bool = False
include_closed: bool = False
closed_start_date: Optional[datetime.datetime] = None
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/History360 HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<History360Response 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>
<Contracts>
<Contract360>
<Amount>0</Amount>
<AmountDue>0</AmountDue>
<ContractItems>
<Item360>
<Condition>String</Condition>
<Price>0</Price>
<PslrId>0</PslrId>
<Quantity>0</Quantity>
<SerialNumber>String</SerialNumber>
<TotalDiscountAmount>0</TotalDiscountAmount>
</Item360>
</ContractItems>
<ContractStatus>String</ContractStatus>
<Id>String</Id>
<LateFee>0</LateFee>
<PaymentDate>0001-01-01T00:00:00</PaymentDate>
<StoreLocationId>0</StoreLocationId>
</Contract360>
</Contracts>
<Invoices>
<Invoice360>
<AmountPaid>0</AmountPaid>
<DueDate>0001-01-01T00:00:00</DueDate>
<Id>String</Id>
<Items>
<Item360>
<Condition>String</Condition>
<Price>0</Price>
<PslrId>0</PslrId>
<Quantity>0</Quantity>
<SerialNumber>String</SerialNumber>
<TotalDiscountAmount>0</TotalDiscountAmount>
</Item360>
</Items>
<LateFeeAmount>0</LateFeeAmount>
<PurchaseDate>0001-01-01T00:00:00</PurchaseDate>
<Status>String</Status>
<StoreLocationId>0</StoreLocationId>
<Total>0</Total>
</Invoice360>
</Invoices>
<Orders>
<Order360>
<Date>0001-01-01T00:00:00</Date>
<Discount>0</Discount>
<Id>0</Id>
<PaymentType>String</PaymentType>
<ShippingAmount>0</ShippingAmount>
<SubTotal>0</SubTotal>
<Tax>0</Tax>
<Total>0</Total>
</Order360>
</Orders>
<WorkOrders>
<WorkOrder360>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Deposit>0</Deposit>
<Id>String</Id>
<Jobs>
<Job360>
<Condition>String</Condition>
<ItemId>String</ItemId>
<ItemType>String</ItemType>
<Price>0</Price>
<Quantity>0</Quantity>
<SerialNumber>String</SerialNumber>
<Title>String</Title>
<TotalDiscountAmount>0</TotalDiscountAmount>
</Job360>
</Jobs>
<Price>0</Price>
<Status>String</Status>
<StoreLocationId>0</StoreLocationId>
</WorkOrder360>
</WorkOrders>
</History360Response>