Studebaker Submetering API Services

<back to all web services

GetConsumptionAnalysis

Get the consumption analysis for a property

To override the Content-type in your clients HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetConsumptionAnalysis

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetConsumptionAnalysis 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>
  <PropertyId>0</PropertyId>
</GetConsumptionAnalysis>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetConsumptionAnalysisResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Consumption.Responses">
  <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>
</GetConsumptionAnalysisResponse>

    </soap:Body>
</soap:Envelope>