Studebaker Submetering API Services

<back to all web services

GetTenantHistory

The following routes are available for this service:
All Verbs/getTenantHistoryGet the transaction and payment history for a tenant
Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintYesThe id of the tenant to get the transaction history for

To override the Content-type in your clients 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 /xml/reply/GetTenantHistory HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

<GetTenantHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.Requests">
  <RequestIpAddress xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</RequestIpAddress>
  <Token xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</Token>
  <TenantId>0</TenantId>
</GetTenantHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTenantHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.Responses">
  <TotalDue>0</TotalDue>
  <TotalInvoiced>0</TotalInvoiced>
  <TotalPayments>0</TotalPayments>
  <Transactions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:TenantTransaction>
      <d2p1:CurrentReading>0</d2p1:CurrentReading>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FormattedTransactionDate>String</d2p1:FormattedTransactionDate>
      <d2p1:Multiplier>0</d2p1:Multiplier>
      <d2p1:PreviousReading>0</d2p1:PreviousReading>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:Rate>0</d2p1:Rate>
      <d2p1:TransactionAmount>0</d2p1:TransactionAmount>
      <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
      <d2p1:Unit>String</d2p1:Unit>
    </d2p1:TenantTransaction>
  </Transactions>
</GetTenantHistoryResponse>