Studebaker Submetering API Services

GetIrregularUsageDetail

Get the current irregular usage details 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: GetIrregularUsageDetail

<?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>

<GetIrregularUsageDetail 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>
  <CycleId>0</CycleId>
  <PropertyId>0</PropertyId>
</GetIrregularUsageDetail>

    </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>

<GetIrregularUsageDetailsResponse 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>
  <HighUsage>0</HighUsage>
  <IrregularUsage xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:IrregularUsage>
      <d2p1:BuildingUnit>String</d2p1:BuildingUnit>
      <d2p1:Details>
        <d2p1:IrregularUsageInfo>
          <d2p1:BuildingUnit>String</d2p1:BuildingUnit>
          <d2p1:IsIrregular>false</d2p1:IsIrregular>
          <d2p1:TenantId>0</d2p1:TenantId>
          <d2p1:TenantName>String</d2p1:TenantName>
          <d2p1:TotalCharge>0</d2p1:TotalCharge>
          <d2p1:TotalUsage>0</d2p1:TotalUsage>
          <d2p1:Type>String</d2p1:Type>
          <d2p1:UnitOfMeasure>String</d2p1:UnitOfMeasure>
          <d2p1:UtilityGroupId>0</d2p1:UtilityGroupId>
          <d2p1:UtilityId>0</d2p1:UtilityId>
          <d2p1:UtilityServiceName>String</d2p1:UtilityServiceName>
        </d2p1:IrregularUsageInfo>
      </d2p1:Details>
      <d2p1:TenantId>0</d2p1:TenantId>
      <d2p1:TenantName>String</d2p1:TenantName>
    </d2p1:IrregularUsage>
  </IrregularUsage>
  <LowUsage>0</LowUsage>
  <Utilities xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:UtilityGroupInfo>
      <d2p1:GroupName>String</d2p1:GroupName>
      <d2p1:Utilities i:nil="true" />
      <d2p1:UtilityGroupId>0</d2p1:UtilityGroupId>
    </d2p1:UtilityGroupInfo>
  </Utilities>
</GetIrregularUsageDetailsResponse>

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