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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CustomerHistoryGeneric() = 
        [<DataMember>]
        member val Date:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val DateStr:String = null with get,set

        [<DataMember>]
        member val Ref:String = null with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val Amount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val OrigAmount:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Late:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val RefType:String = null with get,set

        [<DataMember>]
        member val PO:String = null with get,set

        [<DataMember>]
        member val EstReceivedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetCustomerHistoryResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val CustomerHistory:ResizeArray<CustomerHistoryGeneric> = new ResizeArray<CustomerHistoryGeneric>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///GetCustomerHistoryRequires active-e Customer Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetCustomerHistoryRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val GetInvoices:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetTickets:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetProposals:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetContracts:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetOrders:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetShortTermRentals:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetWebPayments:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val ShowClosed:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetPaymentsDue:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val DateFrom:String = null with get,set

        [<DataMember>]
        member val DateTo:String = null with get,set

        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val GetMemberships:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetPendingWebOrders:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetFutureTeeTimes:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetStationReservations:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetPendingWebRentals:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetValuePacks:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val IncludeUninvoicedScheduling:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val IncludeOnHold:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetConsignments:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val GetRecurringHeaderInfo:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# 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>