GET api/v1/BoilerRooms/ConsumptionUnits/{apikey}

Get all boilerrooms accessible by this API key.

Request Information

URI Parameters

Name	Description	Type	Additional information
apikey	provided by ista	string	Required

Body Parameters

None.

Response Information

Resource Description

List of mBRMEndDevice objects

Collection of mBRMConsumptionUnit

Name	Description	Type	Additional information
Id	Id field of consumption unit	globally unique identifier	None.
PropertyNr	Property number billing system	integer	None.
Index	Index for multiple boiler rooms	integer	None.
Description	BS description of boiler room	string	None.
Location	Location of boiler room	string	None.
Active	Active in BS ( epoch )	decimal number	None.
Inactive	Inactive date ( epoch ) in BS NULL is active	decimal number	None.
GeoLocation	Geo location struct Lat / Long NULL is not availlable	mGeoLocation	None.
City	City where property is located in TPG Format	string	None.
Streets	Property streets struct with high / low homenumber	Collection of mPropStreet	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "638c36f4-0b1b-4f5f-a36f-589486526f3f",
    "PropertyNr": 2,
    "Index": 3,
    "Description": "sample string 4",
    "Location": "sample string 5",
    "Active": 6.1,
    "Inactive": 1.1,
    "GeoLocation": {
      "Latitude": 1.0,
      "Longitude": 2.0
    },
    "City": "sample string 7",
    "Streets": [
      {
        "st": "sample string 1",
        "hl": 2,
        "hh": 3
      },
      {
        "st": "sample string 1",
        "hl": 2,
        "hh": 3
      }
    ]
  },
  {
    "Id": "638c36f4-0b1b-4f5f-a36f-589486526f3f",
    "PropertyNr": 2,
    "Index": 3,
    "Description": "sample string 4",
    "Location": "sample string 5",
    "Active": 6.1,
    "Inactive": 1.1,
    "GeoLocation": {
      "Latitude": 1.0,
      "Longitude": 2.0
    },
    "City": "sample string 7",
    "Streets": [
      {
        "st": "sample string 1",
        "hl": 2,
        "hh": 3
      },
      {
        "st": "sample string 1",
        "hl": 2,
        "hh": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfmBRMConsumptionUnit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ista.web.api.models">
  <mBRMConsumptionUnit>
    <Active>6.1</Active>
    <City>sample string 7</City>
    <Description>sample string 4</Description>
    <GeoLocation>
      <Latitude>1</Latitude>
      <Longitude>2</Longitude>
    </GeoLocation>
    <Id>638c36f4-0b1b-4f5f-a36f-589486526f3f</Id>
    <Inactive>1.1</Inactive>
    <Index>3</Index>
    <Location>sample string 5</Location>
    <PropertyNr>2</PropertyNr>
    <Streets>
      <mPropStreet>
        <HomeNrHigh>3</HomeNrHigh>
        <HomeNrLow>2</HomeNrLow>
        <Street>sample string 1</Street>
      </mPropStreet>
      <mPropStreet>
        <HomeNrHigh>3</HomeNrHigh>
        <HomeNrLow>2</HomeNrLow>
        <Street>sample string 1</Street>
      </mPropStreet>
    </Streets>
  </mBRMConsumptionUnit>
  <mBRMConsumptionUnit>
    <Active>6.1</Active>
    <City>sample string 7</City>
    <Description>sample string 4</Description>
    <GeoLocation>
      <Latitude>1</Latitude>
      <Longitude>2</Longitude>
    </GeoLocation>
    <Id>638c36f4-0b1b-4f5f-a36f-589486526f3f</Id>
    <Inactive>1.1</Inactive>
    <Index>3</Index>
    <Location>sample string 5</Location>
    <PropertyNr>2</PropertyNr>
    <Streets>
      <mPropStreet>
        <HomeNrHigh>3</HomeNrHigh>
        <HomeNrLow>2</HomeNrLow>
        <Street>sample string 1</Street>
      </mPropStreet>
      <mPropStreet>
        <HomeNrHigh>3</HomeNrHigh>
        <HomeNrLow>2</HomeNrLow>
        <Street>sample string 1</Street>
      </mPropStreet>
    </Streets>
  </mBRMConsumptionUnit>
</ArrayOfmBRMConsumptionUnit>