AIM Web Services

AddCustomerRequest

AddCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST	/api/AddCustomer

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 BindableObject:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DependantRecord:
    name: Optional[str] = None
    online_id: Optional[str] = None
    school_district: Optional[str] = None
    school: Optional[str] = None
    id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerDefaultInfo:
    id: int = 0
    desc: Optional[str] = None
    short_desc: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaxAuthorityInfo:
    id: int = 0
    desc: Optional[str] = None
    short_desc: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocationInfo:
    id: int = 0
    desc: Optional[str] = None
    short_desc: Optional[str] = None
    region: Optional[str] = None
    latitude: Decimal = decimal.Decimal(0)
    longitude: Decimal = decimal.Decimal(0)
    in_store_pickup: Optional[str] = None
    active: bool = False
    cash_sale_acct: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdditionalDetail:
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    last_modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    notes: Optional[str] = None
    customer_default: Optional[CustomerDefaultInfo] = None
    tax_authority: Optional[TaxAuthorityInfo] = None
    can_charge: bool = False
    popup_notes: Optional[str] = None
    dl_number: Optional[str] = None
    phone2: Optional[str] = None
    phone3: Optional[str] = None
    phone4: Optional[str] = None
    location: Optional[LocationInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerSearchRecord(BindableObject):
    pk: int = 0
    acct: int = 0
    last: Optional[str] = None
    name: Optional[str] = None
    addr1: Optional[str] = None
    addr2: Optional[str] = None
    city: Optional[str] = None
    st: Optional[str] = None
    zip: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None
    open_invoices: bool = False
    rental_activity: bool = False
    st_loc: Optional[str] = None
    hold: bool = False
    barcode: Optional[str] = None
    color: int = 0
    dependant_info: Optional[List[DependantRecord]] = None
    additional_details: Optional[AdditionalDetail] = None
    matched_on: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddCustomerResponse(BaseResponse):
    id: Optional[int] = None
    # @ApiMember(DataType="string", Description="Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.", Name="PossibleDuplicates")
    possible_duplicates: Optional[List[CustomerSearchRecord]] = None
    """
    Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.
    """


@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 AddCustomerRequest(BaseSecureRequest):
    """
    AddCustomerRequires active-e Customer Service.
    """

    # @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    location_id: Optional[int] = None
    """
    Location ID
    """


    # @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
    customer_default_id: Optional[int] = None
    """
    Customer Default Id
    """


    # @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, 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="array", Description="", Name="FormInputList", ParameterType="query")
    form_input_list: Optional[List[FormInput]] = None
    """
    
    """

    # @ApiMember(Description="Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck.", Name="DuplicateCheckMode")
    duplicate_check_mode: Optional[str] = None
    """
    Can be SKIP, CHECK, or CHECKONLY. Defaults to SKIP. SKIP will not do a duplicate check. CHECK will do a duplicate check and the customer will not added if duplicates are found. CHECKONLY will just do a duplicate check; the customer will not be added. Duplicate check logic is based on the AIM system variable CustDupCheck.
    """

Python AddCustomerRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/AddCustomer HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddCustomerRequest 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>
  <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>
  <DuplicateCheckMode>String</DuplicateCheckMode>
  <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>
  <SS>String</SS>
  <State>String</State>
  <TaxAuthorityId>0</TaxAuthorityId>
  <WorkPhone>String</WorkPhone>
  <Zip>String</Zip>
</AddCustomerRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddCustomerResponse 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>
  <Id>0</Id>
  <PossibleDuplicates xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:CustomerSearchRecord>
      <d2p1:Acct>0</d2p1:Acct>
      <d2p1:AdditionalDetails>
        <d2p1:CanCharge>false</d2p1:CanCharge>
        <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
        <d2p1:CustomerDefault>
          <d2p1:Desc>String</d2p1:Desc>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:ShortDesc>String</d2p1:ShortDesc>
        </d2p1:CustomerDefault>
        <d2p1:DlNumber>String</d2p1:DlNumber>
        <d2p1:LastModifiedDate>0001-01-01T00:00:00</d2p1:LastModifiedDate>
        <d2p1:Location>
          <d2p1:Active>false</d2p1:Active>
          <d2p1:CashSaleAcct>0</d2p1:CashSaleAcct>
          <d2p1:Desc>String</d2p1:Desc>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:InStorePickup>String</d2p1:InStorePickup>
          <d2p1:Latitude>0</d2p1:Latitude>
          <d2p1:Longitude>0</d2p1:Longitude>
          <d2p1:Region>String</d2p1:Region>
          <d2p1:ShortDesc>String</d2p1:ShortDesc>
        </d2p1:Location>
        <d2p1:Notes>String</d2p1:Notes>
        <d2p1:Phone2>String</d2p1:Phone2>
        <d2p1:Phone3>String</d2p1:Phone3>
        <d2p1:Phone4>String</d2p1:Phone4>
        <d2p1:PopupNotes>String</d2p1:PopupNotes>
        <d2p1:TaxAuthority>
          <d2p1:Desc>String</d2p1:Desc>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:ShortDesc>String</d2p1:ShortDesc>
        </d2p1:TaxAuthority>
      </d2p1:AdditionalDetails>
      <d2p1:Addr1>String</d2p1:Addr1>
      <d2p1:Addr2>String</d2p1:Addr2>
      <d2p1:Barcode>String</d2p1:Barcode>
      <d2p1:City>String</d2p1:City>
      <d2p1:Color>0</d2p1:Color>
      <d2p1:DependantInfo>
        <d2p1:CustomerSearchRecord.DependantRecord>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:OnlineId>String</d2p1:OnlineId>
          <d2p1:School>String</d2p1:School>
          <d2p1:SchoolDistrict>String</d2p1:SchoolDistrict>
        </d2p1:CustomerSearchRecord.DependantRecord>
      </d2p1:DependantInfo>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:Hold>false</d2p1:Hold>
      <d2p1:Last>String</d2p1:Last>
      <d2p1:MatchedOn>String</d2p1:MatchedOn>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OpenInvoices>false</d2p1:OpenInvoices>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:Pk>0</d2p1:Pk>
      <d2p1:RentalActivity>false</d2p1:RentalActivity>
      <d2p1:St>String</d2p1:St>
      <d2p1:StLoc>String</d2p1:StLoc>
      <d2p1:Zip>String</d2p1:Zip>
    </d2p1:CustomerSearchRecord>
  </PossibleDuplicates>
</AddCustomerResponse>

AIM Web Services

AddCustomerRequest

AddCustomer Requires active-e Customer Service.

HTTP + XML

AddCustomer
Requires active-e Customer Service.