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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class CustomerHistoryGeneric
{
    // @DataMember
    public Date: string;

    // @DataMember
    public DateStr: string;

    // @DataMember
    public Ref: string;

    // @DataMember
    public Desc: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public OrigAmount: number;

    // @DataMember
    public Late: boolean;

    // @DataMember
    public RefType: string;

    // @DataMember
    public PO: string;

    // @DataMember
    public EstReceivedDate?: string;

    public constructor(init?: Partial<CustomerHistoryGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetCustomerHistoryResponse extends BaseResponse
{
    // @DataMember
    public CustomerHistory: CustomerHistoryGeneric[];

    public constructor(init?: Partial<GetCustomerHistoryResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetCustomerHistoryRequires active-e Customer Service. */
// @DataContract
export class GetCustomerHistoryRequest extends BaseSecureRequest
{
    // @DataMember
    public GetInvoices?: boolean;

    // @DataMember
    public GetTickets?: boolean;

    // @DataMember
    public GetProposals?: boolean;

    // @DataMember
    public GetContracts?: boolean;

    // @DataMember
    public GetOrders?: boolean;

    // @DataMember
    public GetShortTermRentals?: boolean;

    // @DataMember
    public GetWebPayments?: boolean;

    // @DataMember
    public ShowClosed?: boolean;

    // @DataMember
    public GetPaymentsDue?: boolean;

    // @DataMember
    public DateFrom: string;

    // @DataMember
    public DateTo: string;

    // @DataMember
    public Acct?: number;

    // @DataMember
    public GetMemberships?: boolean;

    // @DataMember
    public GetPendingWebOrders?: boolean;

    // @DataMember
    public GetFutureTeeTimes?: boolean;

    // @DataMember
    public GetStationReservations?: boolean;

    // @DataMember
    public GetPendingWebRentals?: boolean;

    // @DataMember
    public GetValuePacks?: boolean;

    // @DataMember
    public IncludeUninvoicedScheduling?: boolean;

    // @DataMember
    public IncludeOnHold?: boolean;

    // @DataMember
    public GetConsignments?: boolean;

    // @DataMember
    public GetRecurringHeaderInfo?: boolean;

    public constructor(init?: Partial<GetCustomerHistoryRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>