| GET | /api/CustomerInfo |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/**
* @type {string}
* @description The OAuthToken token return by AeServices30 */
OAuthToken;
/**
* @type {string}
* @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
DeviceId;
/**
* @type {string}
* @description An identifier for your integration */
AppId;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The Login Token return by the Security API. Required for secured calls. */
Token;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class BindableObject {
constructor(init) { Object.assign(this, init) }
}
export class DependantRecord {
/** @param {{Name?:string,OnlineId?:string,SchoolDistrict?:string,School?:string,Id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
OnlineId;
/** @type {string} */
SchoolDistrict;
/** @type {string} */
School;
/** @type {number} */
Id;
}
export class CustomerDefaultInfo {
/** @param {{Id?:number,Desc?:string,ShortDesc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Desc;
/** @type {string} */
ShortDesc;
}
export class TaxAuthorityInfo {
/** @param {{Id?:number,Desc?:string,ShortDesc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Desc;
/** @type {string} */
ShortDesc;
}
export class LocationInfo {
/** @param {{Id?:number,Desc?:string,ShortDesc?:string,Region?:string,Latitude?:number,Longitude?:number,InStorePickup?:string,Active?:boolean,CashSaleAcct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Desc;
/** @type {string} */
ShortDesc;
/** @type {string} */
Region;
/** @type {number} */
Latitude;
/** @type {number} */
Longitude;
/** @type {string} */
InStorePickup;
/** @type {boolean} */
Active;
/** @type {?number} */
CashSaleAcct;
}
export class AdditionalDetail {
/** @param {{CreationDate?:string,LastModifiedDate?:string,Notes?:string,CustomerDefault?:CustomerDefaultInfo,TaxAuthority?:TaxAuthorityInfo,CanCharge?:boolean,PopupNotes?:string,DlNumber?:string,Phone2?:string,Phone3?:string,Phone4?:string,Location?:LocationInfo}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CreationDate;
/** @type {string} */
LastModifiedDate;
/** @type {string} */
Notes;
/** @type {CustomerDefaultInfo} */
CustomerDefault;
/** @type {TaxAuthorityInfo} */
TaxAuthority;
/** @type {boolean} */
CanCharge;
/** @type {string} */
PopupNotes;
/** @type {string} */
DlNumber;
/** @type {string} */
Phone2;
/** @type {string} */
Phone3;
/** @type {string} */
Phone4;
/** @type {LocationInfo} */
Location;
}
export class CustomerSearchRecord extends BindableObject {
/** @param {{Pk?:number,Acct?:number,Last?:string,Name?:string,Addr1?:string,Addr2?:string,City?:string,St?:string,Zip?:string,Phone?:string,Email?:string,OpenInvoices?:boolean,RentalActivity?:boolean,StLoc?:string,Hold?:boolean,Barcode?:string,Color?:number,DependantInfo?:DependantRecord[],AdditionalDetails?:AdditionalDetail,MatchedOn?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Pk;
/** @type {number} */
Acct;
/** @type {string} */
Last;
/** @type {string} */
Name;
/** @type {string} */
Addr1;
/** @type {string} */
Addr2;
/** @type {string} */
City;
/** @type {string} */
St;
/** @type {string} */
Zip;
/** @type {string} */
Phone;
/** @type {string} */
Email;
/** @type {boolean} */
OpenInvoices;
/** @type {boolean} */
RentalActivity;
/** @type {string} */
StLoc;
/** @type {boolean} */
Hold;
/** @type {string} */
Barcode;
/** @type {number} */
Color;
/** @type {DependantRecord[]} */
DependantInfo;
/** @type {AdditionalDetail} */
AdditionalDetails;
/** @type {string} */
MatchedOn;
}
export class CategoryLevelDiscount {
/** @param {{Category?:number,SubCategory?:number,DiscountType?:string,DiscountAmount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Category;
/** @type {?number} */
SubCategory;
/** @type {string} */
DiscountType;
/** @type {number} */
DiscountAmount;
}
export class CustomerDiscountInfo {
/** @param {{AccessoryInventory?:number,SerializedInventory?:number,ShortTermRental?:number,NonInventory?:number,Labor?:number,MediaInventory?:number,CategoryLevelDiscounts?:CategoryLevelDiscount[],PriceLevel?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AccessoryInventory;
/** @type {number} */
SerializedInventory;
/** @type {number} */
ShortTermRental;
/** @type {number} */
NonInventory;
/** @type {number} */
Labor;
/** @type {number} */
MediaInventory;
/** @type {CategoryLevelDiscount[]} */
CategoryLevelDiscounts;
/** @type {string} */
PriceLevel;
}
export class CustomerMembershipInfo {
/** @param {{Description?:string,TeeLevel?:number,WebTeeLevel?:number,StationLevel?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {number} */
TeeLevel;
/** @type {number} */
WebTeeLevel;
/** @type {number} */
StationLevel;
}
export class CustomerEmailInfo {
/** @param {{Description?:string,Email?:string,Method?:string,Type?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {string} */
Email;
/** @type {string} */
Method;
/** @type {string} */
Type;
}
export class AttributeValue {
/** @param {{Name?:string,Tag?:string,Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Tag;
/** @type {string} */
Value;
}
export class CustomerInfoResponse extends BaseResponse {
/** @param {{Customer?:CustomerSearchRecord,DiscountInfo?:CustomerDiscountInfo,Memberships?:CustomerMembershipInfo[],Emails?:CustomerEmailInfo[],Attributes?:AttributeValue[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CustomerSearchRecord} */
Customer;
/** @type {CustomerDiscountInfo} */
DiscountInfo;
/** @type {CustomerMembershipInfo[]} */
Memberships;
/** @type {CustomerEmailInfo[]} */
Emails;
/** @type {AttributeValue[]} */
Attributes;
}
export class CustomerInfoRequest extends BaseSecureRequest {
/** @param {{Acct?:number,Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Acct;
}
JavaScript CustomerInfoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/CustomerInfo HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerInfoResponse 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>
<Attributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:AttributeValue>
<d2p1:Name>String</d2p1:Name>
<d2p1:Tag>String</d2p1:Tag>
<d2p1:Value>String</d2p1:Value>
</d2p1:AttributeValue>
</Attributes>
<Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<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>
</Customer>
<DiscountInfo>
<AccessoryInventory>0</AccessoryInventory>
<CategoryLevelDiscounts>
<CategoryLevelDiscount>
<Category>0</Category>
<DiscountAmount>0</DiscountAmount>
<DiscountType>String</DiscountType>
<SubCategory>0</SubCategory>
</CategoryLevelDiscount>
</CategoryLevelDiscounts>
<Labor>0</Labor>
<MediaInventory>0</MediaInventory>
<NonInventory>0</NonInventory>
<PriceLevel>String</PriceLevel>
<SerializedInventory>0</SerializedInventory>
<ShortTermRental>0</ShortTermRental>
</DiscountInfo>
<Emails>
<CustomerEmailInfo>
<Description>String</Description>
<Email>String</Email>
<Method>String</Method>
<Type>String</Type>
</CustomerEmailInfo>
</Emails>
<Memberships>
<CustomerMembershipInfo>
<Description>String</Description>
<StationLevel>0</StationLevel>
<TeeLevel>0</TeeLevel>
<WebTeeLevel>0</WebTeeLevel>
</CustomerMembershipInfo>
</Memberships>
</CustomerInfoResponse>