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
GetCustomerHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
GetInvoicesbodybool?No
GetTicketsbodybool?No
GetProposalsbodybool?No
GetContractsbodybool?No
GetOrdersbodybool?No
GetShortTermRentalsbodybool?No
GetWebPaymentsbodybool?No
ShowClosedbodybool?No
GetPaymentsDuebodybool?No
DateFrombodystringNo
DateTobodystringNo
Acctbodyint?No
GetMembershipsbodybool?No
GetPendingWebOrdersbodybool?No
GetFutureTeeTimesbodybool?No
GetStationReservationsbodybool?No
GetPendingWebRentalsbodybool?No
GetValuePacksbodybool?No
IncludeUninvoicedSchedulingbodybool?No
IncludeOnHoldbodybool?No
GetConsignmentsbodybool?No
GetRecurringHeaderInfobodybool?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
GetCustomerHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerHistoryformList<CustomerHistoryGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
CustomerHistoryGeneric Parameters:
NameParameterData TypeRequiredDescription
DateformDateTimeNo
DateStrformstringNo
RefformstringNo
DescformstringNo
AmountformdecimalNo
OrigAmountformdecimalNo
LateformboolNo
RefTypeformstringNo
POformstringNo
EstReceivedDateformDateTime?No

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>