AIM Web Services

AddCustomerRequest

AddCustomer
Requires active-e Customer Service.

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

**AddCustomerRequest** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	query	integer	Yes	Location ID
CustomerDefaultId	query	integer	Yes	Customer Default Id
TaxAuthorityId	query	integer	Yes	Tax Authority Id
Name	body	string	No
Attn	body	string	No
Address1	body	string	No
Address2	body	string	No
City	body	string	No
State	body	string	No
Zip	body	string	No
Country	body	string	No
HomePhone	body	string	No
WorkPhone	body	string	No
CellPhone	body	string	No
Employer	body	string	No
SS	body	string	No
Email	body	string	No
EmailMethod	query	string	No	Email Method. Set this to Word, PDF, HTML, or None
Notes	body	string	No
DriversLicenseInfo	body	LicenseInfo	No
FormInputList	query	array	No
DuplicateCheckMode	body	string	No	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.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**LicenseInfo** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	No
Height	form	string	No
Weight	form	string	No
Hair	form	string	No
Eyes	form	string	No
Expiration	form	string	No
Birthday	form	string	No
Ethnicity	form	string	No
Gender	form	string	No
State	form	string	No

**FormInput** Parameters:
Name	Parameter	Data Type	Required	Description
Key	query	string	Yes	Field Name of the Input Field
Value	query	string	Yes	Value of the Input Field.
Encrypted	query	boolean	Yes	Whether or not the field is encryped with the C2B encryption key.

**AddCustomerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int?	No
PossibleDuplicates	form	string	No	Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was not created.

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**CustomerSearchRecord** Parameters:
Name	Parameter	Data Type	Required
Pk	form	long	No
Acct	form	int	No
Last	form	string	No
Name	form	string	No
Addr1	form	string	No
Addr2	form	string	No
City	form	string	No
St	form	string	No
Zip	form	string	No
Phone	form	string	No
Email	form	string	No
OpenInvoices	form	bool	No
RentalActivity	form	bool	No
StLoc	form	string	No
Hold	form	bool	No
Barcode	form	string	No
Color	form	int	No
DependantInfo	form	List<DependantRecord>	No
AdditionalDetails	form	AdditionalDetail	No
MatchedOn	form	string	No

**DependantRecord** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
OnlineId	form	string	No
SchoolDistrict	form	string	No
School	form	string	No
Id	form	long	No

**AdditionalDetail** Parameters:
Name	Parameter	Data Type	Required
CreationDate	form	DateTime	No
LastModifiedDate	form	DateTime	No
Notes	form	string	No
CustomerDefault	form	CustomerDefaultInfo	No
TaxAuthority	form	TaxAuthorityInfo	No
CanCharge	form	bool	No
PopupNotes	form	string	No
DlNumber	form	string	No
Phone2	form	string	No
Phone3	form	string	No
Phone4	form	string	No
Location	form	LocationInfo	No

**CustomerDefaultInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No

**TaxAuthorityInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No

**LocationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No
Region	form	string	No
Latitude	form	decimal	No
Longitude	form	decimal	No
InStorePickup	form	string	No
Active	form	bool	No

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: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.