Studebaker Submetering API Services

<back to all web services

GetVacantConsumption

The following routes are available for this service:
All Verbs/getVacantConsumptionGet the vacant consumption for a propertySet the cycle id if you know it, otherwise set the property id and we will use the most recently invoiced cycle

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

<GetVacantConsumption 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>
</GetVacantConsumption>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetVacantConsumptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Consumption.Responses">
  <VacantConsumption xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:VacantConsumption>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:BuildingAndUnit>String</d2p1:BuildingAndUnit>
      <d2p1:InReading>0</d2p1:InReading>
      <d2p1:Measure>String</d2p1:Measure>
      <d2p1:Multiplier>0</d2p1:Multiplier>
      <d2p1:OutReading>0</d2p1:OutReading>
      <d2p1:PendingMoveIn>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:Prefix>String</d2p1:Prefix>
        <d2p1:Suffix>String</d2p1:Suffix>
      </d2p1:PendingMoveIn>
      <d2p1:Rate>0</d2p1:Rate>
      <d2p1:ServiceName>String</d2p1:ServiceName>
      <d2p1:UnitId>0</d2p1:UnitId>
      <d2p1:Usage>0</d2p1:Usage>
      <d2p1:VacantFrom>0001-01-01T00:00:00</d2p1:VacantFrom>
      <d2p1:VacantTo>0001-01-01T00:00:00</d2p1:VacantTo>
    </d2p1:VacantConsumption>
  </VacantConsumption>
</GetVacantConsumptionResponse>