AIM Web Services

<back to all web services

AdvancedCustomerSearchRequest

AdvancedCustomerSearch
Requires active-e Customer Service.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * AdvancedCustomerSearchRequires active-e Customer Service.
    */
    @DataContract
    public static class AdvancedCustomerSearchRequest extends BaseSecureRequest
    {
        /**
        * The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup)
        */
        @DataMember
        @ApiMember(DataType="string", Description="The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup)", IsRequired=true, Name="SearchType")
        public String SearchType = null;

        /**
        * What to search for
        */
        @DataMember
        @ApiMember(DataType="string", Description="What to search for", IsRequired=true, Name="SearchString")
        public String SearchString = null;

        /**
        * The Starting Offset. Defaults to 0 if not sent.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="The Starting Offset. Defaults to 0 if not sent.", Format="int64", Name="StartOffset")
        public Long StartOffset = null;

        /**
        * The # of records to be returned. Defaults to 100 if not sent.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="The # of records to be returned. Defaults to 100 if not sent.", Format="int64", Name="RecordCount")
        public Long RecordCount = null;
        
        public String getSearchType() { return SearchType; }
        public AdvancedCustomerSearchRequest setSearchType(String value) { this.SearchType = value; return this; }
        public String getSearchString() { return SearchString; }
        public AdvancedCustomerSearchRequest setSearchString(String value) { this.SearchString = value; return this; }
        public Long getStartOffset() { return StartOffset; }
        public AdvancedCustomerSearchRequest setStartOffset(Long value) { this.StartOffset = value; return this; }
        public Long getRecordCount() { return RecordCount; }
        public AdvancedCustomerSearchRequest setRecordCount(Long value) { this.RecordCount = 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 AdvancedCustomerSearchResponse extends BaseResponse
    {
        @DataMember
        public Long RemainingRecords = null;

        @DataMember
        public ArrayList<AdvancedCustomerSearchRecord> Customers = null;
        
        public Long getRemainingRecords() { return RemainingRecords; }
        public AdvancedCustomerSearchResponse setRemainingRecords(Long value) { this.RemainingRecords = value; return this; }
        public ArrayList<AdvancedCustomerSearchRecord> getCustomers() { return Customers; }
        public AdvancedCustomerSearchResponse setCustomers(ArrayList<AdvancedCustomerSearchRecord> 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 AdvancedCustomerSearchRecord
    {
        @DataMember
        public Integer Acct = null;

        @DataMember
        public Integer Sub = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String ResultType = null;

        @DataMember
        public String ResultDetail = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public BigDecimal Amount = null;
        
        public Integer getAcct() { return Acct; }
        public AdvancedCustomerSearchRecord setAcct(Integer value) { this.Acct = value; return this; }
        public Integer getSub() { return Sub; }
        public AdvancedCustomerSearchRecord setSub(Integer value) { this.Sub = value; return this; }
        public String getName() { return Name; }
        public AdvancedCustomerSearchRecord setName(String value) { this.Name = value; return this; }
        public String getResultType() { return ResultType; }
        public AdvancedCustomerSearchRecord setResultType(String value) { this.ResultType = value; return this; }
        public String getResultDetail() { return ResultDetail; }
        public AdvancedCustomerSearchRecord setResultDetail(String value) { this.ResultDetail = value; return this; }
        public Date getDateTime() { return DateTime; }
        public AdvancedCustomerSearchRecord setDateTime(Date value) { this.DateTime = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public AdvancedCustomerSearchRecord setAmount(BigDecimal value) { this.Amount = value; return this; }
    }

}

Java AdvancedCustomerSearchRequest DTOs

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

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

<AdvancedCustomerSearchResponse 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>
    <AdvancedCustomerSearchRecord>
      <Acct>0</Acct>
      <Amount>0</Amount>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <Name>String</Name>
      <ResultDetail>String</ResultDetail>
      <ResultType>String</ResultType>
      <Sub>0</Sub>
    </AdvancedCustomerSearchRecord>
  </Customers>
  <RemainingRecords>0</RemainingRecords>
</AdvancedCustomerSearchResponse>