| POST | /api/UpdateCustomer |
|---|
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 UpdateCustomerResponse(BaseResponse):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseInfo:
number: Optional[str] = None
height: Optional[str] = None
weight: Optional[str] = None
hair: Optional[str] = None
eyes: Optional[str] = None
expiration: Optional[str] = None
birthday: Optional[str] = None
ethnicity: Optional[str] = None
gender: Optional[str] = None
state: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInput:
# @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
key: Optional[str] = None
"""
Field Name of the Input Field
"""
# @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
value: Optional[str] = None
"""
Value of the Input Field.
"""
# @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
encrypted: bool = False
"""
Whether or not the field is encryped with the C2B encryption key.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateCustomerRequest(BaseSecureRequest):
"""
UpdateCustomerRequires active-e Customer Service.
"""
# @ApiMember(DataType="integer", Description="Customer Acct #", Format="int32", IsRequired=true, Name="Acct", ParameterType="query")
acct: int = 0
"""
Customer Acct #
"""
# @ApiMember(DataType="integer", Description="Location ID", Format="int64", Name="LocationId", ParameterType="query")
location_id: Optional[int] = None
"""
Location ID
"""
# @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", Name="CustomerDefaultId", ParameterType="query")
customer_default_id: Optional[int] = None
"""
Customer Default Id
"""
# @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", Name="TaxAuthorityId", ParameterType="query")
tax_authority_id: Optional[int] = None
"""
Tax Authority Id
"""
name: Optional[str] = None
attn: Optional[str] = None
address1: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
country: Optional[str] = None
home_phone: Optional[str] = None
work_phone: Optional[str] = None
cell_phone: Optional[str] = None
employer: Optional[str] = None
ss: Optional[str] = None
email: Optional[str] = None
# @ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")
email_method: Optional[str] = None
"""
Email Method. Set this to Word, PDF, HTML, or None
"""
notes: Optional[str] = None
drivers_license_info: Optional[LicenseInfo] = None
# @ApiMember(DataType="bool", Description="If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.", Name="RefreshCustomerDefaults", ParameterType="query")
refresh_customer_defaults: bool = False
"""
If TRUE, all applicable settings from the customer default will be copied over to the customer. Generally only used when changing the customer default.
"""
# @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
form_input_list: Optional[List[FormInput]] = None
"""
"""
Python UpdateCustomerRequest 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/UpdateCustomer HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateCustomerRequest 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>
<Address1>String</Address1>
<Address2>String</Address2>
<Attn>String</Attn>
<CellPhone>String</CellPhone>
<City>String</City>
<Country>String</Country>
<CustomerDefaultId>0</CustomerDefaultId>
<DriversLicenseInfo>
<Birthday>String</Birthday>
<Ethnicity>String</Ethnicity>
<Expiration>String</Expiration>
<Eyes>String</Eyes>
<Gender>String</Gender>
<Hair>String</Hair>
<Height>String</Height>
<Number>String</Number>
<State>String</State>
<Weight>String</Weight>
</DriversLicenseInfo>
<Email>String</Email>
<EmailMethod>String</EmailMethod>
<Employer>String</Employer>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<HomePhone>String</HomePhone>
<LocationId>0</LocationId>
<Name>String</Name>
<Notes>String</Notes>
<RefreshCustomerDefaults>false</RefreshCustomerDefaults>
<SS>String</SS>
<State>String</State>
<TaxAuthorityId>0</TaxAuthorityId>
<WorkPhone>String</WorkPhone>
<Zip>String</Zip>
</UpdateCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateCustomerResponse 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>
</UpdateCustomerResponse>