GET api/v1/BoilerRooms/EndDevices/{apikey}/{ConsUnitId}

Get enddevices in this consumption unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

required

string

Required

ConsUnitId

required

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

List of mBRMEndDevice objects

Collection of mBRMEndDevice
NameDescriptionTypeAdditional information
Id

End device id

globally unique identifier

None.

MeterNumber

SS meternumber BS

string

None.

ArticleNumber

SS articlenumber BS

string

None.

Output

SS output BS

integer

None.

Description

Description of device

string

None.

Unit

Units of measurement of device BS

string

None.

Location

Location of device as text

string

None.

Group

Calculation group of the device

string

None.

Active

Date when device is/has been set active

decimal number

None.

Inactive

Date when device is/or has been set inactive

decimal number

None.

FirstVal

the first measured value date of the device

decimal number

None.

LastVal

the last measured value date of the device

decimal number

None.

HasHighFreq

when true this meter has high frequency measured values

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "059623c5-1d5f-4f33-8326-56e13d68a8f1",
    "MeterNumber": "sample string 2",
    "ArticleNumber": "sample string 3",
    "Output": 4,
    "Description": "sample string 5",
    "Unit": "sample string 6",
    "Location": "sample string 7",
    "Group": "sample string 8",
    "Active": 9.1,
    "Inactive": 1.1,
    "FirstVal": 1.1,
    "LastVal": 1.1,
    "HasHighFreq": true
  },
  {
    "Id": "059623c5-1d5f-4f33-8326-56e13d68a8f1",
    "MeterNumber": "sample string 2",
    "ArticleNumber": "sample string 3",
    "Output": 4,
    "Description": "sample string 5",
    "Unit": "sample string 6",
    "Location": "sample string 7",
    "Group": "sample string 8",
    "Active": 9.1,
    "Inactive": 1.1,
    "FirstVal": 1.1,
    "LastVal": 1.1,
    "HasHighFreq": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfmBRMEndDevice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ista.web.api.models">
  <mBRMEndDevice>
    <Active>9.1</Active>
    <ArticleNumber>sample string 3</ArticleNumber>
    <Description>sample string 5</Description>
    <FirstVal>1.1</FirstVal>
    <Group>sample string 8</Group>
    <HasHighFreq>true</HasHighFreq>
    <Id>059623c5-1d5f-4f33-8326-56e13d68a8f1</Id>
    <Inactive>1.1</Inactive>
    <LastVal>1.1</LastVal>
    <Location>sample string 7</Location>
    <MeterNumber>sample string 2</MeterNumber>
    <Output>4</Output>
    <Unit>sample string 6</Unit>
  </mBRMEndDevice>
  <mBRMEndDevice>
    <Active>9.1</Active>
    <ArticleNumber>sample string 3</ArticleNumber>
    <Description>sample string 5</Description>
    <FirstVal>1.1</FirstVal>
    <Group>sample string 8</Group>
    <HasHighFreq>true</HasHighFreq>
    <Id>059623c5-1d5f-4f33-8326-56e13d68a8f1</Id>
    <Inactive>1.1</Inactive>
    <LastVal>1.1</LastVal>
    <Location>sample string 7</Location>
    <MeterNumber>sample string 2</MeterNumber>
    <Output>4</Output>
    <Unit>sample string 6</Unit>
  </mBRMEndDevice>
</ArrayOfmBRMEndDevice>