AIM Web Services

<back to all web services

GetCustomerHistoryRequest

GetCustomerHistory
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/GetCustomerHistory
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class CustomerHistoryGeneric
            <DataMember>
            Public Overridable Property [Date] As Date

            <DataMember>
            Public Overridable Property DateStr As String

            <DataMember>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property OrigAmount As Decimal

            <DataMember>
            Public Overridable Property Late As Boolean

            <DataMember>
            Public Overridable Property RefType As String

            <DataMember>
            Public Overridable Property PO As String

            <DataMember>
            Public Overridable Property EstReceivedDate As Nullable(Of Date)
        End Class
    End Namespace

    Namespace AIM.WebService

        <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

        '''<Summary>
        '''GetCustomerHistoryRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class GetCustomerHistoryRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property GetInvoices As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetTickets As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetProposals As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetContracts As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetOrders As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetShortTermRentals As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetWebPayments As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property ShowClosed As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetPaymentsDue As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property DateFrom As String

            <DataMember>
            Public Overridable Property DateTo As String

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

            <DataMember>
            Public Overridable Property GetMemberships As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetPendingWebOrders As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetFutureTeeTimes As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetStationReservations As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetPendingWebRentals As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetValuePacks As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property IncludeUninvoicedScheduling As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property IncludeOnHold As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetConsignments As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property GetRecurringHeaderInfo As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class GetCustomerHistoryResponse
            Inherits BaseResponse
            Public Sub New()
                CustomerHistory = New List(Of CustomerHistoryGeneric)
            End Sub

            <DataMember>
            Public Overridable Property CustomerHistory As List(Of CustomerHistoryGeneric)
        End Class
    End Namespace
End Namespace

VB.NET GetCustomerHistoryRequest 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.

POST /api/GetCustomerHistory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCustomerHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <DateFrom>String</DateFrom>
  <DateTo>String</DateTo>
  <GetConsignments>false</GetConsignments>
  <GetContracts>false</GetContracts>
  <GetFutureTeeTimes>false</GetFutureTeeTimes>
  <GetInvoices>false</GetInvoices>
  <GetMemberships>false</GetMemberships>
  <GetOrders>false</GetOrders>
  <GetPaymentsDue>false</GetPaymentsDue>
  <GetPendingWebOrders>false</GetPendingWebOrders>
  <GetPendingWebRentals>false</GetPendingWebRentals>
  <GetProposals>false</GetProposals>
  <GetRecurringHeaderInfo>false</GetRecurringHeaderInfo>
  <GetShortTermRentals>false</GetShortTermRentals>
  <GetStationReservations>false</GetStationReservations>
  <GetTickets>false</GetTickets>
  <GetValuePacks>false</GetValuePacks>
  <GetWebPayments>false</GetWebPayments>
  <IncludeOnHold>false</IncludeOnHold>
  <IncludeUninvoicedScheduling>false</IncludeUninvoicedScheduling>
  <ShowClosed>false</ShowClosed>
</GetCustomerHistoryRequest>

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

<GetCustomerHistoryResponse 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>
  <CustomerHistory xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:CustomerHistoryGeneric i:nil="true" />
  </CustomerHistory>
</GetCustomerHistoryResponse>