AIM Web Services

<back to all web services

AddCustomerRequest

AddCustomer
Requires active-e Customer Service.

The following routes are available for this service:
POST/api/AddCustomer
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* AddCustomerRequires active-e Customer Service.
*/
@DataContract
open class AddCustomerRequest : BaseSecureRequest()
{
    /**
    * Location ID
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    var LocationId:Long? = null

    /**
    * Customer Default Id
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
    var CustomerDefaultId:Long? = null

    /**
    * Tax Authority Id
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")
    var TaxAuthorityId:Long? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Attn:String? = null

    @DataMember
    var Address1:String? = null

    @DataMember
    var Address2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var State:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Country:String? = null

    @DataMember
    var HomePhone:String? = null

    @DataMember
    var WorkPhone:String? = null

    @DataMember
    var CellPhone:String? = null

    @DataMember
    var Employer:String? = null

    @DataMember
    var SS:String? = null

    @DataMember
    var Email:String? = null

    /**
    * Email Method. Set this to Word, PDF, HTML, or None
    */
    @DataMember
    @ApiMember(DataType="string", Description="Email Method. Set this to Word, PDF, HTML, or None", Name="EmailMethod", ParameterType="query")
    var EmailMethod:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var DriversLicenseInfo:LicenseInfo? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    var FormInputList:ArrayList<FormInput> = ArrayList<FormInput>()

    /**
    * 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.
    */
    @DataMember
    @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")
    var DuplicateCheckMode:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class LicenseInfo
{
    @DataMember
    var Number:String? = null

    @DataMember
    var Height:String? = null

    @DataMember
    var Weight:String? = null

    @DataMember
    var Hair:String? = null

    @DataMember
    var Eyes:String? = null

    @DataMember
    var Expiration:String? = null

    @DataMember
    var Birthday:String? = null

    @DataMember
    var Ethnicity:String? = null

    @DataMember
    var Gender:String? = null

    @DataMember
    var State:String? = null
}

@DataContract(Name="FormInput")
open class FormInput
{
    /**
    * Field Name of the Input Field
    */
    @DataMember
    @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    var Key:String? = null

    /**
    * Value of the Input Field.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    var Value:String? = null

    /**
    * Whether or not the field is encryped with the C2B encryption key.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    var Encrypted:Boolean? = null
}

@DataContract
open class AddCustomerResponse : BaseResponse()
{
    @DataMember
    var Id:Int? = null

    /**
    * Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created.
    */
    @DataMember
    @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")
    var PossibleDuplicates:ArrayList<CustomerSearchRecord> = ArrayList<CustomerSearchRecord>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class CustomerSearchRecord : BindableObject()
{
    @DataMember
    var Pk:Long? = null

    @DataMember
    var Acct:Int? = null

    @DataMember
    var Last:String? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Addr1:String? = null

    @DataMember
    var Addr2:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var St:String? = null

    @DataMember
    var Zip:String? = null

    @DataMember
    var Phone:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var OpenInvoices:Boolean? = null

    @DataMember
    var RentalActivity:Boolean? = null

    @DataMember
    var StLoc:String? = null

    @DataMember
    var Hold:Boolean? = null

    @DataMember
    var Barcode:String? = null

    @DataMember
    var Color:Int? = null

    @DataMember
    var DependantInfo:ArrayList<DependantRecord> = ArrayList<DependantRecord>()

    @DataMember
    var AdditionalDetails:AdditionalDetail? = null

    @DataMember
    var MatchedOn:String? = null
}

@DataContract
open class BindableObject
{
}

@DataContract
open class DependantRecord
{
    @DataMember
    var Name:String? = null

    @DataMember
    var OnlineId:String? = null

    @DataMember
    var SchoolDistrict:String? = null

    @DataMember
    var School:String? = null

    @DataMember
    var Id:Long? = null
}

@DataContract
open class AdditionalDetail
{
    @DataMember
    var CreationDate:Date? = null

    @DataMember
    var LastModifiedDate:Date? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var CustomerDefault:CustomerDefaultInfo? = null

    @DataMember
    var TaxAuthority:TaxAuthorityInfo? = null

    @DataMember
    var CanCharge:Boolean? = null

    @DataMember
    var PopupNotes:String? = null

    @DataMember
    var DlNumber:String? = null

    @DataMember
    var Phone2:String? = null

    @DataMember
    var Phone3:String? = null

    @DataMember
    var Phone4:String? = null

    @DataMember
    var Location:LocationInfo? = null
}

@DataContract
open class CustomerDefaultInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null
}

@DataContract
open class TaxAuthorityInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var Region:String? = null

    @DataMember
    var Latitude:BigDecimal? = null

    @DataMember
    var Longitude:BigDecimal? = null

    @DataMember
    var InStorePickup:String? = null

    @DataMember
    var Active:Boolean? = null

    @DataMember
    var CashSaleAcct:Int? = null
}

Kotlin 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>