AIM Web Services

<back to all web services

AdvancedCustomerSearchRequest

AdvancedCustomerSearch
Requires active-e Customer Service.

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AdvancedCustomerSearchRecord
{
    // @DataMember
    public Acct: number;

    // @DataMember
    public Sub?: number;

    // @DataMember
    public Name: string;

    // @DataMember
    public ResultType: string;

    // @DataMember
    public ResultDetail: string;

    // @DataMember
    public DateTime?: string;

    // @DataMember
    public Amount?: number;

    public constructor(init?: Partial<AdvancedCustomerSearchRecord>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AdvancedCustomerSearchResponse extends BaseResponse
{
    // @DataMember
    public RemainingRecords: number;

    // @DataMember
    public Customers: AdvancedCustomerSearchRecord[];

    public constructor(init?: Partial<AdvancedCustomerSearchResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description AdvancedCustomerSearchRequires active-e Customer Service. */
// @DataContract
export class AdvancedCustomerSearchRequest extends BaseSecureRequest
{
    /** @description 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 SearchType: string;

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

    /** @description 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 StartOffset?: number;

    /** @description 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 RecordCount?: number;

    public constructor(init?: Partial<AdvancedCustomerSearchRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>