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

// @DataContract
export class BaseRequest
{
    /** @description 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")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BindableObject
{

    public constructor(init?: Partial<BindableObject>) { (Object as any).assign(this, init); }
}

// @DataContract
export class DependantRecord
{
    // @DataMember
    public Name: string;

    // @DataMember
    public OnlineId: string;

    // @DataMember
    public SchoolDistrict: string;

    // @DataMember
    public School: string;

    // @DataMember
    public Id: number;

    public constructor(init?: Partial<DependantRecord>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerDefaultInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    public constructor(init?: Partial<CustomerDefaultInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class TaxAuthorityInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    public constructor(init?: Partial<TaxAuthorityInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class LocationInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ShortDesc: string;

    // @DataMember
    public Region: string;

    // @DataMember
    public Latitude: number;

    // @DataMember
    public Longitude: number;

    // @DataMember
    public InStorePickup: string;

    // @DataMember
    public Active: boolean;

    // @DataMember
    public CashSaleAcct?: number;

    public constructor(init?: Partial<LocationInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AdditionalDetail
{
    // @DataMember
    public CreationDate: string;

    // @DataMember
    public LastModifiedDate: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public CustomerDefault: CustomerDefaultInfo;

    // @DataMember
    public TaxAuthority: TaxAuthorityInfo;

    // @DataMember
    public CanCharge: boolean;

    // @DataMember
    public PopupNotes: string;

    // @DataMember
    public DlNumber: string;

    // @DataMember
    public Phone2: string;

    // @DataMember
    public Phone3: string;

    // @DataMember
    public Phone4: string;

    // @DataMember
    public Location: LocationInfo;

    public constructor(init?: Partial<AdditionalDetail>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerSearchRecord extends BindableObject
{
    // @DataMember
    public Pk: number;

    // @DataMember
    public Acct: number;

    // @DataMember
    public Last: string;

    // @DataMember
    public Name: string;

    // @DataMember
    public Addr1: string;

    // @DataMember
    public Addr2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public St: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Phone: string;

    // @DataMember
    public Email: string;

    // @DataMember
    public OpenInvoices: boolean;

    // @DataMember
    public RentalActivity: boolean;

    // @DataMember
    public StLoc: string;

    // @DataMember
    public Hold: boolean;

    // @DataMember
    public Barcode: string;

    // @DataMember
    public Color: number;

    // @DataMember
    public DependantInfo: DependantRecord[];

    // @DataMember
    public AdditionalDetails: AdditionalDetail;

    // @DataMember
    public MatchedOn: string;

    public constructor(init?: Partial<CustomerSearchRecord>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AddCustomerResponse extends BaseResponse
{
    // @DataMember
    public Id?: number;

    /** @description 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")
    public PossibleDuplicates: CustomerSearchRecord[];

    public constructor(init?: Partial<AddCustomerResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class LicenseInfo
{
    // @DataMember
    public Number: string;

    // @DataMember
    public Height: string;

    // @DataMember
    public Weight: string;

    // @DataMember
    public Hair: string;

    // @DataMember
    public Eyes: string;

    // @DataMember
    public Expiration: string;

    // @DataMember
    public Birthday: string;

    // @DataMember
    public Ethnicity: string;

    // @DataMember
    public Gender: string;

    // @DataMember
    public State: string;

    public constructor(init?: Partial<LicenseInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="FormInput")
export class FormInput
{
    /** @description Field Name of the Input Field */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    public Key: string;

    /** @description Value of the Input Field. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    public Value: string;

    /** @description 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")
    public Encrypted: boolean;

    public constructor(init?: Partial<FormInput>) { (Object as any).assign(this, init); }
}

/** @description AddCustomerRequires active-e Customer Service. */
// @DataContract
export class AddCustomerRequest extends BaseSecureRequest
{
    /** @description Location ID */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Location ID", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    public LocationId: number;

    /** @description Customer Default Id */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Customer Default Id", Format="int64", IsRequired=true, Name="CustomerDefaultId", ParameterType="query")
    public CustomerDefaultId: number;

    /** @description Tax Authority Id */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Tax Authority Id", Format="int64", IsRequired=true, Name="TaxAuthorityId", ParameterType="query")
    public TaxAuthorityId: number;

    // @DataMember
    public Name: string;

    // @DataMember
    public Attn: string;

    // @DataMember
    public Address1: string;

    // @DataMember
    public Address2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Country: string;

    // @DataMember
    public HomePhone: string;

    // @DataMember
    public WorkPhone: string;

    // @DataMember
    public CellPhone: string;

    // @DataMember
    public Employer: string;

    // @DataMember
    public SS: string;

    // @DataMember
    public Email: string;

    /** @description 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")
    public EmailMethod: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public DriversLicenseInfo: LicenseInfo;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    public FormInputList: FormInput[];

    /** @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. */
    // @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")
    public DuplicateCheckMode: string;

    public constructor(init?: Partial<AddCustomerRequest>) { super(init); (Object as any).assign(this, init); }
}

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