| GET | /api/SearchCustomers |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* SearchCustomersRequires active-e Customer Service.
*/
@DataContract
public static class SearchCustomersRequest extends BaseSecureRequest
{
@DataMember
public String SearchString = null;
@DataMember
public Boolean IncludeStoreAccounts = null;
@DataMember
public Long StartOffset = null;
@DataMember
public Long RecordCount = null;
@DataMember
public Boolean IncludeDependants = null;
@DataMember
public Boolean IncludeAdditionalDetails = null;
@DataMember
public Date ChangedDate = null;
@DataMember
public Long LocId = null;
public String getSearchString() { return SearchString; }
public SearchCustomersRequest setSearchString(String value) { this.SearchString = value; return this; }
public Boolean isIncludeStoreAccounts() { return IncludeStoreAccounts; }
public SearchCustomersRequest setIncludeStoreAccounts(Boolean value) { this.IncludeStoreAccounts = value; return this; }
public Long getStartOffset() { return StartOffset; }
public SearchCustomersRequest setStartOffset(Long value) { this.StartOffset = value; return this; }
public Long getRecordCount() { return RecordCount; }
public SearchCustomersRequest setRecordCount(Long value) { this.RecordCount = value; return this; }
public Boolean isIncludeDependants() { return IncludeDependants; }
public SearchCustomersRequest setIncludeDependants(Boolean value) { this.IncludeDependants = value; return this; }
public Boolean isIncludeAdditionalDetails() { return IncludeAdditionalDetails; }
public SearchCustomersRequest setIncludeAdditionalDetails(Boolean value) { this.IncludeAdditionalDetails = value; return this; }
public Date getChangedDate() { return ChangedDate; }
public SearchCustomersRequest setChangedDate(Date value) { this.ChangedDate = value; return this; }
public Long getLocId() { return LocId; }
public SearchCustomersRequest setLocId(Long value) { this.LocId = value; return this; }
}
@DataContract
public static class BaseSecureRequest extends BaseRequest
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public String Token = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public String DeviceId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public String AppId = null;
public String getToken() { return Token; }
public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
public String getDeviceId() { return DeviceId; }
public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
public String getAppId() { return AppId; }
public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
}
@DataContract
public static class BaseRequest
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
@DataMember
@ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
public String ApiKey = null;
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public String OAuthToken = null;
public String getApiKey() { return ApiKey; }
public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
public String getOAuthToken() { return OAuthToken; }
public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
}
@DataContract
public static class SearchCustomersResponse extends BaseResponse
{
@DataMember
public Long StartOffset = null;
@DataMember
public Long RecordCount = null;
@DataMember
public Long RemainingRecords = null;
@DataMember
public Long TotalRecords = null;
@DataMember
public ArrayList<CustomerSearchRecord> Customers = null;
public Long getStartOffset() { return StartOffset; }
public SearchCustomersResponse setStartOffset(Long value) { this.StartOffset = value; return this; }
public Long getRecordCount() { return RecordCount; }
public SearchCustomersResponse setRecordCount(Long value) { this.RecordCount = value; return this; }
public Long getRemainingRecords() { return RemainingRecords; }
public SearchCustomersResponse setRemainingRecords(Long value) { this.RemainingRecords = value; return this; }
public Long getTotalRecords() { return TotalRecords; }
public SearchCustomersResponse setTotalRecords(Long value) { this.TotalRecords = value; return this; }
public ArrayList<CustomerSearchRecord> getCustomers() { return Customers; }
public SearchCustomersResponse setCustomers(ArrayList<CustomerSearchRecord> value) { this.Customers = value; return this; }
}
@DataContract
public static class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public BaseResponseResult Status = null;
public BaseResponseResult getStatus() { return Status; }
public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
}
@DataContract
public static class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public String StatusCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public String Login = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public String ErrorCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public String ErrorDisplayText = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public String ErrorMessage = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public String DomainName = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public String IpAddress = null;
public String getStatusCode() { return StatusCode; }
public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
public String getLogin() { return Login; }
public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
public String getErrorCode() { return ErrorCode; }
public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getErrorDisplayText() { return ErrorDisplayText; }
public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
public String getErrorMessage() { return ErrorMessage; }
public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
public String getDomainName() { return DomainName; }
public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
public String getIpAddress() { return IpAddress; }
public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
}
@DataContract
public static class CustomerSearchRecord extends BindableObject
{
@DataMember
public Long Pk = null;
@DataMember
public Integer Acct = null;
@DataMember
public String Last = null;
@DataMember
public String Name = null;
@DataMember
public String Addr1 = null;
@DataMember
public String Addr2 = null;
@DataMember
public String City = null;
@DataMember
public String St = null;
@DataMember
public String Zip = null;
@DataMember
public String Phone = null;
@DataMember
public String Email = null;
@DataMember
public Boolean OpenInvoices = null;
@DataMember
public Boolean RentalActivity = null;
@DataMember
public String StLoc = null;
@DataMember
public Boolean Hold = null;
@DataMember
public String Barcode = null;
@DataMember
public Integer Color = null;
@DataMember
public ArrayList<DependantRecord> DependantInfo = null;
@DataMember
public AdditionalDetail AdditionalDetails = null;
@DataMember
public String MatchedOn = null;
public Long getPk() { return Pk; }
public CustomerSearchRecord setPk(Long value) { this.Pk = value; return this; }
public Integer getAcct() { return Acct; }
public CustomerSearchRecord setAcct(Integer value) { this.Acct = value; return this; }
public String getLast() { return Last; }
public CustomerSearchRecord setLast(String value) { this.Last = value; return this; }
public String getName() { return Name; }
public CustomerSearchRecord setName(String value) { this.Name = value; return this; }
public String getAddr1() { return Addr1; }
public CustomerSearchRecord setAddr1(String value) { this.Addr1 = value; return this; }
public String getAddr2() { return Addr2; }
public CustomerSearchRecord setAddr2(String value) { this.Addr2 = value; return this; }
public String getCity() { return City; }
public CustomerSearchRecord setCity(String value) { this.City = value; return this; }
public String getSt() { return St; }
public CustomerSearchRecord setSt(String value) { this.St = value; return this; }
public String getZip() { return Zip; }
public CustomerSearchRecord setZip(String value) { this.Zip = value; return this; }
public String getPhone() { return Phone; }
public CustomerSearchRecord setPhone(String value) { this.Phone = value; return this; }
public String getEmail() { return Email; }
public CustomerSearchRecord setEmail(String value) { this.Email = value; return this; }
public Boolean isOpenInvoices() { return OpenInvoices; }
public CustomerSearchRecord setOpenInvoices(Boolean value) { this.OpenInvoices = value; return this; }
public Boolean isRentalActivity() { return RentalActivity; }
public CustomerSearchRecord setRentalActivity(Boolean value) { this.RentalActivity = value; return this; }
public String getStLoc() { return StLoc; }
public CustomerSearchRecord setStLoc(String value) { this.StLoc = value; return this; }
public Boolean isHold() { return Hold; }
public CustomerSearchRecord setHold(Boolean value) { this.Hold = value; return this; }
public String getBarcode() { return Barcode; }
public CustomerSearchRecord setBarcode(String value) { this.Barcode = value; return this; }
public Integer getColor() { return Color; }
public CustomerSearchRecord setColor(Integer value) { this.Color = value; return this; }
public ArrayList<DependantRecord> getDependantInfo() { return DependantInfo; }
public CustomerSearchRecord setDependantInfo(ArrayList<DependantRecord> value) { this.DependantInfo = value; return this; }
public AdditionalDetail getAdditionalDetails() { return AdditionalDetails; }
public CustomerSearchRecord setAdditionalDetails(AdditionalDetail value) { this.AdditionalDetails = value; return this; }
public String getMatchedOn() { return MatchedOn; }
public CustomerSearchRecord setMatchedOn(String value) { this.MatchedOn = value; return this; }
}
@DataContract
public static class BindableObject
{
}
@DataContract
public static class DependantRecord
{
@DataMember
public String Name = null;
@DataMember
public String OnlineId = null;
@DataMember
public String SchoolDistrict = null;
@DataMember
public String School = null;
@DataMember
public Long Id = null;
public String getName() { return Name; }
public DependantRecord setName(String value) { this.Name = value; return this; }
public String getOnlineId() { return OnlineId; }
public DependantRecord setOnlineId(String value) { this.OnlineId = value; return this; }
public String getSchoolDistrict() { return SchoolDistrict; }
public DependantRecord setSchoolDistrict(String value) { this.SchoolDistrict = value; return this; }
public String getSchool() { return School; }
public DependantRecord setSchool(String value) { this.School = value; return this; }
public Long getId() { return Id; }
public DependantRecord setId(Long value) { this.Id = value; return this; }
}
@DataContract
public static class AdditionalDetail
{
@DataMember
public Date CreationDate = null;
@DataMember
public Date LastModifiedDate = null;
@DataMember
public String Notes = null;
@DataMember
public CustomerDefaultInfo CustomerDefault = null;
@DataMember
public TaxAuthorityInfo TaxAuthority = null;
@DataMember
public Boolean CanCharge = null;
@DataMember
public String PopupNotes = null;
@DataMember
public String DlNumber = null;
@DataMember
public String Phone2 = null;
@DataMember
public String Phone3 = null;
@DataMember
public String Phone4 = null;
@DataMember
public LocationInfo Location = null;
public Date getCreationDate() { return CreationDate; }
public AdditionalDetail setCreationDate(Date value) { this.CreationDate = value; return this; }
public Date getLastModifiedDate() { return LastModifiedDate; }
public AdditionalDetail setLastModifiedDate(Date value) { this.LastModifiedDate = value; return this; }
public String getNotes() { return Notes; }
public AdditionalDetail setNotes(String value) { this.Notes = value; return this; }
public CustomerDefaultInfo getCustomerDefault() { return CustomerDefault; }
public AdditionalDetail setCustomerDefault(CustomerDefaultInfo value) { this.CustomerDefault = value; return this; }
public TaxAuthorityInfo getTaxAuthority() { return TaxAuthority; }
public AdditionalDetail setTaxAuthority(TaxAuthorityInfo value) { this.TaxAuthority = value; return this; }
public Boolean isCanCharge() { return CanCharge; }
public AdditionalDetail setCanCharge(Boolean value) { this.CanCharge = value; return this; }
public String getPopupNotes() { return PopupNotes; }
public AdditionalDetail setPopupNotes(String value) { this.PopupNotes = value; return this; }
public String getDlNumber() { return DlNumber; }
public AdditionalDetail setDlNumber(String value) { this.DlNumber = value; return this; }
public String getPhone2() { return Phone2; }
public AdditionalDetail setPhone2(String value) { this.Phone2 = value; return this; }
public String getPhone3() { return Phone3; }
public AdditionalDetail setPhone3(String value) { this.Phone3 = value; return this; }
public String getPhone4() { return Phone4; }
public AdditionalDetail setPhone4(String value) { this.Phone4 = value; return this; }
public LocationInfo getLocation() { return Location; }
public AdditionalDetail setLocation(LocationInfo value) { this.Location = value; return this; }
}
@DataContract
public static class CustomerDefaultInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Desc = null;
@DataMember
public String ShortDesc = null;
public Long getId() { return Id; }
public CustomerDefaultInfo setId(Long value) { this.Id = value; return this; }
public String getDesc() { return Desc; }
public CustomerDefaultInfo setDesc(String value) { this.Desc = value; return this; }
public String getShortDesc() { return ShortDesc; }
public CustomerDefaultInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
}
@DataContract
public static class TaxAuthorityInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Desc = null;
@DataMember
public String ShortDesc = null;
public Long getId() { return Id; }
public TaxAuthorityInfo setId(Long value) { this.Id = value; return this; }
public String getDesc() { return Desc; }
public TaxAuthorityInfo setDesc(String value) { this.Desc = value; return this; }
public String getShortDesc() { return ShortDesc; }
public TaxAuthorityInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
}
@DataContract
public static class LocationInfo
{
@DataMember
public Long Id = null;
@DataMember
public String Desc = null;
@DataMember
public String ShortDesc = null;
@DataMember
public String Region = null;
@DataMember
public BigDecimal Latitude = null;
@DataMember
public BigDecimal Longitude = null;
@DataMember
public String InStorePickup = null;
@DataMember
public Boolean Active = null;
@DataMember
public Integer CashSaleAcct = null;
public Long getId() { return Id; }
public LocationInfo setId(Long value) { this.Id = value; return this; }
public String getDesc() { return Desc; }
public LocationInfo setDesc(String value) { this.Desc = value; return this; }
public String getShortDesc() { return ShortDesc; }
public LocationInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
public String getRegion() { return Region; }
public LocationInfo setRegion(String value) { this.Region = value; return this; }
public BigDecimal getLatitude() { return Latitude; }
public LocationInfo setLatitude(BigDecimal value) { this.Latitude = value; return this; }
public BigDecimal getLongitude() { return Longitude; }
public LocationInfo setLongitude(BigDecimal value) { this.Longitude = value; return this; }
public String getInStorePickup() { return InStorePickup; }
public LocationInfo setInStorePickup(String value) { this.InStorePickup = value; return this; }
public Boolean isActive() { return Active; }
public LocationInfo setActive(Boolean value) { this.Active = value; return this; }
public Integer getCashSaleAcct() { return CashSaleAcct; }
public LocationInfo setCashSaleAcct(Integer value) { this.CashSaleAcct = value; return this; }
}
}
Java SearchCustomersRequest 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/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>