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

namespace AIM
{
    [DataContract]
    public partial class CustomerHistoryGeneric
    {
        [DataMember]
        public virtual DateTime Date { get; set; }

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

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

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

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

        [DataMember]
        public virtual decimal OrigAmount { get; set; }

        [DataMember]
        public virtual bool Late { get; set; }

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

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

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

}

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 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; }
    }

    ///<summary>
    ///GetCustomerHistoryRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class GetCustomerHistoryRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual bool? GetInvoices { get; set; }

        [DataMember]
        public virtual bool? GetTickets { get; set; }

        [DataMember]
        public virtual bool? GetProposals { get; set; }

        [DataMember]
        public virtual bool? GetContracts { get; set; }

        [DataMember]
        public virtual bool? GetOrders { get; set; }

        [DataMember]
        public virtual bool? GetShortTermRentals { get; set; }

        [DataMember]
        public virtual bool? GetWebPayments { get; set; }

        [DataMember]
        public virtual bool? ShowClosed { get; set; }

        [DataMember]
        public virtual bool? GetPaymentsDue { get; set; }

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

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

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

        [DataMember]
        public virtual bool? GetMemberships { get; set; }

        [DataMember]
        public virtual bool? GetPendingWebOrders { get; set; }

        [DataMember]
        public virtual bool? GetFutureTeeTimes { get; set; }

        [DataMember]
        public virtual bool? GetStationReservations { get; set; }

        [DataMember]
        public virtual bool? GetPendingWebRentals { get; set; }

        [DataMember]
        public virtual bool? GetValuePacks { get; set; }

        [DataMember]
        public virtual bool? IncludeUninvoicedScheduling { get; set; }

        [DataMember]
        public virtual bool? IncludeOnHold { get; set; }

        [DataMember]
        public virtual bool? GetConsignments { get; set; }

        [DataMember]
        public virtual bool? GetRecurringHeaderInfo { get; set; }
    }

    [DataContract]
    public partial class GetCustomerHistoryResponse
        : BaseResponse
    {
        public GetCustomerHistoryResponse()
        {
            CustomerHistory = new List<CustomerHistoryGeneric>{};
        }

        [DataMember]
        public virtual List<CustomerHistoryGeneric> CustomerHistory { get; set; }
    }

}

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