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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class AdvancedCustomerSearchRecord
            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property Sub As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property ResultType As String

            <DataMember>
            Public Overridable Property ResultDetail As String

            <DataMember>
            Public Overridable Property DateTime As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Amount As Nullable(Of Decimal)
        End Class

        '''<Summary>
        '''AdvancedCustomerSearchRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class AdvancedCustomerSearchRequest
            Inherits 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 Overridable Property SearchType As String

            '''<Summary>
            '''What to search for
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="What to search for", IsRequired:=true, Name:="SearchString")>
            Public Overridable Property SearchString As String

            '''<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 Overridable Property StartOffset As Nullable(Of Long)

            '''<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 Overridable Property RecordCount As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class AdvancedCustomerSearchResponse
            Inherits BaseResponse
            Public Sub New()
                Customers = New List(Of AdvancedCustomerSearchRecord)
            End Sub

            <DataMember>
            Public Overridable Property RemainingRecords As Long

            <DataMember>
            Public Overridable Property Customers As List(Of AdvancedCustomerSearchRecord)
        End Class

        <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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class
    End Namespace
End Namespace

VB.NET AdvancedCustomerSearchRequest 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/AdvancedCustomerSearch HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"RemainingRecords":0,"Customers":[{"Acct":0,"Sub":0,"Name":"String","ResultType":"String","ResultDetail":"String","DateTime":"0001-01-01T00:00:00.0000000","Amount":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}