AIM Web Services

<back to all web services

SearchCustomersRequest

SearchCustomers
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/SearchCustomers
"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 SearchCustomersResponse extends BaseResponse {
    /** @param {{StartOffset?:number,RecordCount?:number,RemainingRecords?:number,TotalRecords?:number,Customers?:CustomerSearchRecord[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    StartOffset;
    /** @type {number} */
    RecordCount;
    /** @type {number} */
    RemainingRecords;
    /** @type {number} */
    TotalRecords;
    /** @type {CustomerSearchRecord[]} */
    Customers;
}
export class SearchCustomersRequest extends BaseSecureRequest {
    /** @param {{SearchString?:string,IncludeStoreAccounts?:boolean,StartOffset?:number,RecordCount?:number,IncludeDependants?:boolean,IncludeAdditionalDetails?:boolean,ChangedDate?:string,LocId?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    SearchString;
    /** @type {?boolean} */
    IncludeStoreAccounts;
    /** @type {?number} */
    StartOffset;
    /** @type {?number} */
    RecordCount;
    /** @type {?boolean} */
    IncludeDependants;
    /** @type {?boolean} */
    IncludeAdditionalDetails;
    /** @type {?string} */
    ChangedDate;
    /** @type {?number} */
    LocId;
}

JavaScript SearchCustomersRequest 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

HTTP + JSON

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/json

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

{"StartOffset":0,"RecordCount":0,"RemainingRecords":0,"TotalRecords":0,"Customers":[{"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"}}