| POST | /api/AddCustomer |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Token;
/** @type {string} */
DeviceId;
/** @type {string} */
AppId;
}
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 AddCustomerResponse extends BaseResponse {
/** @param {{Id?:number,PossibleDuplicates?:CustomerSearchRecord[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
Id;
/**
* @type {CustomerSearchRecord[]}
* @description Only returned if PerformDuplicateCheck parameter was passed in and possible duplicates were found. If this is returned, the customer record was *not* created. */
PossibleDuplicates;
}
export class LicenseInfo {
/** @param {{Number?:string,Height?:string,Weight?:string,Hair?:string,Eyes?:string,Expiration?:string,Birthday?:string,Ethnicity?:string,Gender?:string,State?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Number;
/** @type {string} */
Height;
/** @type {string} */
Weight;
/** @type {string} */
Hair;
/** @type {string} */
Eyes;
/** @type {string} */
Expiration;
/** @type {string} */
Birthday;
/** @type {string} */
Ethnicity;
/** @type {string} */
Gender;
/** @type {string} */
State;
}
export class FormInput {
/** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Field Name of the Input Field */
Key;
/**
* @type {string}
* @description Value of the Input Field. */
Value;
/**
* @type {boolean}
* @description Whether or not the field is encryped with the C2B encryption key. */
Encrypted;
}
export class AddCustomerRequest extends BaseSecureRequest {
/** @param {{LocationId?:number,CustomerDefaultId?:number,TaxAuthorityId?:number,Name?:string,Attn?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,HomePhone?:string,WorkPhone?:string,CellPhone?:string,Employer?:string,SS?:string,Email?:string,EmailMethod?:string,Notes?:string,DriversLicenseInfo?:LicenseInfo,FormInputList?:FormInput[],DuplicateCheckMode?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description Location ID */
LocationId;
/**
* @type {number}
* @description Customer Default Id */
CustomerDefaultId;
/**
* @type {number}
* @description Tax Authority Id */
TaxAuthorityId;
/** @type {string} */
Name;
/** @type {string} */
Attn;
/** @type {string} */
Address1;
/** @type {string} */
Address2;
/** @type {string} */
City;
/** @type {string} */
State;
/** @type {string} */
Zip;
/** @type {string} */
Country;
/** @type {string} */
HomePhone;
/** @type {string} */
WorkPhone;
/** @type {string} */
CellPhone;
/** @type {string} */
Employer;
/** @type {string} */
SS;
/** @type {string} */
Email;
/**
* @type {string}
* @description Email Method. Set this to Word, PDF, HTML, or None */
EmailMethod;
/** @type {string} */
Notes;
/** @type {LicenseInfo} */
DriversLicenseInfo;
/** @type {FormInput[]} */
FormInputList;
/**
* @type {string}
* @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. */
DuplicateCheckMode;
}
JavaScript AddCustomerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"LocationId":0,"CustomerDefaultId":0,"TaxAuthorityId":0,"Name":"String","Attn":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","HomePhone":"String","WorkPhone":"String","CellPhone":"String","Employer":"String","SS":"String","Email":"String","EmailMethod":"String","Notes":"String","DriversLicenseInfo":{"Number":"String","Height":"String","Weight":"String","Hair":"String","Eyes":"String","Expiration":"String","Birthday":"String","Ethnicity":"String","Gender":"String","State":"String"},"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"DuplicateCheckMode":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Id":0,"PossibleDuplicates":[{"Pk":0,"Acct":0,"Last":"String","Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Phone":"String","Email":"String","OpenInvoices":false,"RentalActivity":false,"StLoc":"String","Hold":false,"Barcode":"String","Color":0,"DependantInfo":[{"Name":"String","OnlineId":"String","SchoolDistrict":"String","School":"String","Id":0}],"AdditionalDetails":{"Notes":"String","CustomerDefault":{"Id":0,"Desc":"String","ShortDesc":"String"},"TaxAuthority":{"Id":0,"Desc":"String","ShortDesc":"String"},"CanCharge":false,"PopupNotes":"String","DlNumber":"String","Phone2":"String","Phone3":"String","Phone4":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}},"MatchedOn":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}