Studebaker Submetering API Services

<back to all web services

GetTenantConsumptionReport

Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintYesThe id of the tenant
FilterByAgeInMonthspathintNoThe age filter (defaults to 6 months)
FilterByUtilityGroupIdpathintNoFilter by this utility group id (defaults to no filter)
FilterByUtilityIdpathintNoFilter by this utility id (defaults to no filter)

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/GetTenantConsumptionReport HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

<GetTenantConsumptionReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Consumption.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>
  <FilterByAgeInMonths>0</FilterByAgeInMonths>
  <FilterByUtilityGroupId>0</FilterByUtilityGroupId>
  <FilterByUtilityId>0</FilterByUtilityId>
  <TenantId>0</TenantId>
</GetTenantConsumptionReport>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTenantConsumptionReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Consumption.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Months xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:ConsumptionReportData>
      <d2p1:Consumption>
        <d2p1:ConsumptionReportDataDetail>
          <d2p1:DollarAmount>0</d2p1:DollarAmount>
          <d2p1:IsVacantConsumption>false</d2p1:IsVacantConsumption>
          <d2p1:Measure>String</d2p1:Measure>
          <d2p1:Usage>0</d2p1:Usage>
          <d2p1:UtilityGroupId>0</d2p1:UtilityGroupId>
          <d2p1:UtilityGroupName>String</d2p1:UtilityGroupName>
          <d2p1:UtilityId>0</d2p1:UtilityId>
          <d2p1:UtilityName>String</d2p1:UtilityName>
        </d2p1:ConsumptionReportDataDetail>
      </d2p1:Consumption>
      <d2p1:CycleStart>0001-01-01T00:00:00</d2p1:CycleStart>
      <d2p1:MonthName>String</d2p1:MonthName>
    </d2p1:ConsumptionReportData>
  </Months>
</GetTenantConsumptionReportResponse>