AIM Web Services

<back to all web services

AdvancedCustomerSearchRequest

AdvancedCustomerSearch
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/AdvancedCustomerSearch
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class AdvancedCustomerSearchRecord
    {
        [DataMember]
        public virtual int Acct { get; set; }

        [DataMember]
        public virtual int? Sub { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string ResultType { get; set; }

        [DataMember]
        public virtual string ResultDetail { get; set; }

        [DataMember]
        public virtual DateTime? DateTime { get; set; }

        [DataMember]
        public virtual decimal? Amount { get; set; }
    }

    ///<summary>
    ///AdvancedCustomerSearchRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class AdvancedCustomerSearchRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///The type of advanced search. Options are SUBACCOUNT (Students and Dependents), CHECK (Exact Check# lookup), and CREDITCARD (Last 4 lookup)
        ///</summary>
        [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 virtual string SearchType { get; set; }

        ///<summary>
        ///What to search for
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="What to search for", IsRequired=true, Name="SearchString")]
        public virtual string SearchString { get; set; }

        ///<summary>
        ///The Starting Offset. Defaults to 0 if not sent.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The Starting Offset. Defaults to 0 if not sent.", Format="int64", Name="StartOffset")]
        public virtual long? StartOffset { get; set; }

        ///<summary>
        ///The # of records to be returned. Defaults to 100 if not sent.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The # of records to be returned. Defaults to 100 if not sent.", Format="int64", Name="RecordCount")]
        public virtual long? RecordCount { get; set; }
    }

    [DataContract]
    public partial class AdvancedCustomerSearchResponse
        : BaseResponse
    {
        public AdvancedCustomerSearchResponse()
        {
            Customers = new List<AdvancedCustomerSearchRecord>{};
        }

        [DataMember]
        public virtual long RemainingRecords { get; set; }

        [DataMember]
        public virtual List<AdvancedCustomerSearchRecord> Customers { get; set; }
    }

    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

}

C# AdvancedCustomerSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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>