Studebaker Submetering API Services

<back to all web services

GetConsumptionHistory

The following routes are available for this service:
All Verbs/getConsumptionHistoryGet the building/units for a property

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

<GetConsumptionHistory 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>
  <FilterByBuildingId>0</FilterByBuildingId>
  <FilterByCycleId>0</FilterByCycleId>
  <FilterByUnitId>0</FilterByUnitId>
  <FilterByUtilityId>0</FilterByUtilityId>
  <PropertyId>0</PropertyId>
</GetConsumptionHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetConsumptionHistoryResponse 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>
  <Consumption xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:ConsumptionInfo>
      <d2p1:CycleStartDate>0001-01-01T00:00:00</d2p1:CycleStartDate>
      <d2p1:TotalCharge>0</d2p1:TotalCharge>
      <d2p1:TotalUsage>0</d2p1:TotalUsage>
      <d2p1:UnitOfMeasure>String</d2p1:UnitOfMeasure>
      <d2p1:UtilityInfo>
        <d2p1:ConsumptionDetailInfo>
          <d2p1:Charge>0</d2p1:Charge>
          <d2p1:Usage>0</d2p1:Usage>
          <d2p1:UtilityName>String</d2p1:UtilityName>
        </d2p1:ConsumptionDetailInfo>
      </d2p1:UtilityInfo>
      <d2p1:UtilityServiceName>String</d2p1:UtilityServiceName>
    </d2p1:ConsumptionInfo>
  </Consumption>
</GetConsumptionHistoryResponse>