Studebaker Submetering API Services

GetIrregularUsage

The following routes are available for this service:
All Verbs	/getIrregularUsage	Get the current irregular usage summary 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/GetIrregularUsage HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

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

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

<GetIrregularUsageResponse 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 xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <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>
  </HighUsage>
  <LowUsage xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <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>
  </LowUsage>
</GetIrregularUsageResponse>