AIM Web Services

SearchCustomersRequest

SearchCustomers
Requires active-e Customer Service.

The following routes are available for this service:
GET	/api/SearchCustomers

**SearchCustomersRequest** Parameters:
Name	Parameter	Data Type	Required
SearchString	query	string	No
IncludeStoreAccounts	query	bool?	No
StartOffset	query	long?	No
RecordCount	query	long?	No
IncludeDependants	query	bool?	No
IncludeAdditionalDetails	query	bool?	No
ChangedDate	query	DateTime?	No
LocId	query	long?	No

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

**SearchCustomersResponse** Parameters:
Name	Parameter	Data Type	Required
StartOffset	form	long	No
RecordCount	form	long	No
RemainingRecords	form	long	No
TotalRecords	form	long	No
Customers	form	List<CustomerSearchRecord>	No

**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
CashSaleAcct	form	int?	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.

GET /api/SearchCustomers HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<SearchCustomersResponse 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>
  <Customers 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>
  </Customers>
  <RecordCount>0</RecordCount>
  <RemainingRecords>0</RemainingRecords>
  <StartOffset>0</StartOffset>
  <TotalRecords>0</TotalRecords>
</SearchCustomersResponse>

AIM Web Services

SearchCustomersRequest

SearchCustomers Requires active-e Customer Service.

HTTP + XML

SearchCustomers
Requires active-e Customer Service.