| POST, GET | /api/GetCustomerHistory |
|---|
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 CustomerHistoryGeneric:
date: datetime.datetime = datetime.datetime(1, 1, 1)
date_str: Optional[str] = None
ref: Optional[str] = None
desc: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
orig_amount: Decimal = decimal.Decimal(0)
late: bool = False
ref_type: Optional[str] = None
po: Optional[str] = None
est_received_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerHistoryResponse(BaseResponse):
customer_history: Optional[List[CustomerHistoryGeneric]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerHistoryRequest(BaseSecureRequest):
"""
GetCustomerHistoryRequires active-e Customer Service.
"""
get_invoices: Optional[bool] = None
get_tickets: Optional[bool] = None
get_proposals: Optional[bool] = None
get_contracts: Optional[bool] = None
get_orders: Optional[bool] = None
get_short_term_rentals: Optional[bool] = None
get_web_payments: Optional[bool] = None
show_closed: Optional[bool] = None
get_payments_due: Optional[bool] = None
date_from: Optional[str] = None
date_to: Optional[str] = None
acct: Optional[int] = None
get_memberships: Optional[bool] = None
get_pending_web_orders: Optional[bool] = None
get_future_tee_times: Optional[bool] = None
get_station_reservations: Optional[bool] = None
get_pending_web_rentals: Optional[bool] = None
get_value_packs: Optional[bool] = None
include_uninvoiced_scheduling: Optional[bool] = None
include_on_hold: Optional[bool] = None
get_consignments: Optional[bool] = None
get_recurring_header_info: Optional[bool] = None
Python GetCustomerHistoryRequest 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/GetCustomerHistory HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCustomerHistoryRequest 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>
<Acct>0</Acct>
<DateFrom>String</DateFrom>
<DateTo>String</DateTo>
<GetConsignments>false</GetConsignments>
<GetContracts>false</GetContracts>
<GetFutureTeeTimes>false</GetFutureTeeTimes>
<GetInvoices>false</GetInvoices>
<GetMemberships>false</GetMemberships>
<GetOrders>false</GetOrders>
<GetPaymentsDue>false</GetPaymentsDue>
<GetPendingWebOrders>false</GetPendingWebOrders>
<GetPendingWebRentals>false</GetPendingWebRentals>
<GetProposals>false</GetProposals>
<GetRecurringHeaderInfo>false</GetRecurringHeaderInfo>
<GetShortTermRentals>false</GetShortTermRentals>
<GetStationReservations>false</GetStationReservations>
<GetTickets>false</GetTickets>
<GetValuePacks>false</GetValuePacks>
<GetWebPayments>false</GetWebPayments>
<IncludeOnHold>false</IncludeOnHold>
<IncludeUninvoicedScheduling>false</IncludeUninvoicedScheduling>
<ShowClosed>false</ShowClosed>
</GetCustomerHistoryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCustomerHistoryResponse 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>
<CustomerHistory xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:CustomerHistoryGeneric i:nil="true" />
</CustomerHistory>
</GetCustomerHistoryResponse>