GET {lang}/Beacons/Query/{format}/{interfaceid}/{orgid}?OrganizationId={OrganizationId}&UID={UID}&Start={Start}&Limit={Limit}&SiteId={SiteId}&_id={_id}&Floor={Floor}&Name={Name}&BeaconType={BeaconType}&Protocol={Protocol}&InstallationDate={InstallationDate}&Zone={Zone}&Room={Room}&Latitude={Latitude}&Longitude={Longitude}&RadioTXPowerFrom={RadioTXPowerFrom}&RadioTXPowerTo={RadioTXPowerTo}&LastUsedFrom={LastUsedFrom}&LastUsedTo={LastUsedTo}&BatteryPercentFrom={BatteryPercentFrom}&BatteryPercentTo={BatteryPercentTo}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
format

string

Required

interfaceid

integer

Required

orgid

integer

Required

OrganizationId

integer

None.

UID

string

None.

Start

integer

None.

Limit

integer

None.

SiteId

string

None.

_id

string

None.

Floor

integer

None.

Name

string

None.

BeaconType

BeaconType

None.

Protocol

string

None.

InstallationDate

date

None.

Zone

string

None.

Room

string

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

RadioTXPowerFrom

decimal number

None.

RadioTXPowerTo

decimal number

None.

LastUsedFrom

date

None.

LastUsedTo

date

None.

BatteryPercentFrom

integer

None.

BatteryPercentTo

integer

None.

lang

string

None.

Body Parameters

None.

Response Information

Resource Description

GenericPagingResultOfBeaconData
NameDescriptionTypeAdditional information
Total

integer

None.

Items

Collection of BeaconData

None.

Response Formats

application/json; charset=utf-8, application/json, application/vnd.google-earth.kml+xml, text/plain, image/png, text/csv, application/x-www-form-urlencoded

Sample:
{
  "Items": [
    {
      "_id": "sample string 1",
      "OrganizationId": 2,
      "UID": "sample string 3",
      "Name": "sample string 4",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Floor": 5,
      "RssiCali": 6.1,
      "Rssi": 7.1,
      "LastUsed": "2026-06-03T17:27:12.4029264Z",
      "Distance": 1.1,
      "Battery": 1,
      "SiteId": "sample string 8",
      "BeaconType": 0,
      "Protocol": "sample string 9",
      "TestedDate": "2026-06-03T17:27:12.4029264Z",
      "InstallationDate": "2026-06-03T17:27:12.4029264Z",
      "AdvertisingInterval": 1.1,
      "RadioTXPower": 1.1,
      "Building": "sample string 10",
      "Zone": "sample string 11",
      "Room": "sample string 12",
      "LocationDescription": "sample string 13",
      "BatteryPercent": 14,
      "CreatedDate": "2026-06-03T17:27:12.4029264Z"
    },
    {
      "_id": "sample string 1",
      "OrganizationId": 2,
      "UID": "sample string 3",
      "Name": "sample string 4",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "Floor": 5,
      "RssiCali": 6.1,
      "Rssi": 7.1,
      "LastUsed": "2026-06-03T17:27:12.4029264Z",
      "Distance": 1.1,
      "Battery": 1,
      "SiteId": "sample string 8",
      "BeaconType": 0,
      "Protocol": "sample string 9",
      "TestedDate": "2026-06-03T17:27:12.4029264Z",
      "InstallationDate": "2026-06-03T17:27:12.4029264Z",
      "AdvertisingInterval": 1.1,
      "RadioTXPower": 1.1,
      "Building": "sample string 10",
      "Zone": "sample string 11",
      "Room": "sample string 12",
      "LocationDescription": "sample string 13",
      "BatteryPercent": 14,
      "CreatedDate": "2026-06-03T17:27:12.4029264Z"
    }
  ],
  "Total": 1
}

application/xml; charset=utf-8, application/xml

Sample:
<GenericPagingResultOfBeaconData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <BeaconData>
      <_id>sample string 1</_id>
      <OrganizationId>2</OrganizationId>
      <UID>sample string 3</UID>
      <Name>sample string 4</Name>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Floor>5</Floor>
      <RssiCali>6.1</RssiCali>
      <Rssi>7.1</Rssi>
      <LastUsed>2026-06-03T17:27:12.4029264+00:00</LastUsed>
      <Distance>1.1</Distance>
      <Battery>1</Battery>
      <SiteId>sample string 8</SiteId>
      <BeaconType>Other</BeaconType>
      <Protocol>sample string 9</Protocol>
      <TestedDate>2026-06-03T17:27:12.4029264+00:00</TestedDate>
      <InstallationDate>2026-06-03T17:27:12.4029264+00:00</InstallationDate>
      <AdvertisingInterval>1.1</AdvertisingInterval>
      <RadioTXPower>1.1</RadioTXPower>
      <Building>sample string 10</Building>
      <Zone>sample string 11</Zone>
      <Room>sample string 12</Room>
      <LocationDescription>sample string 13</LocationDescription>
      <BatteryPercent>14</BatteryPercent>
      <CreatedDate>2026-06-03T17:27:12.4029264+00:00</CreatedDate>
    </BeaconData>
    <BeaconData>
      <_id>sample string 1</_id>
      <OrganizationId>2</OrganizationId>
      <UID>sample string 3</UID>
      <Name>sample string 4</Name>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <Floor>5</Floor>
      <RssiCali>6.1</RssiCali>
      <Rssi>7.1</Rssi>
      <LastUsed>2026-06-03T17:27:12.4029264+00:00</LastUsed>
      <Distance>1.1</Distance>
      <Battery>1</Battery>
      <SiteId>sample string 8</SiteId>
      <BeaconType>Other</BeaconType>
      <Protocol>sample string 9</Protocol>
      <TestedDate>2026-06-03T17:27:12.4029264+00:00</TestedDate>
      <InstallationDate>2026-06-03T17:27:12.4029264+00:00</InstallationDate>
      <AdvertisingInterval>1.1</AdvertisingInterval>
      <RadioTXPower>1.1</RadioTXPower>
      <Building>sample string 10</Building>
      <Zone>sample string 11</Zone>
      <Room>sample string 12</Room>
      <LocationDescription>sample string 13</LocationDescription>
      <BatteryPercent>14</BatteryPercent>
      <CreatedDate>2026-06-03T17:27:12.4029264+00:00</CreatedDate>
    </BeaconData>
  </Items>
  <Total>1</Total>
</GenericPagingResultOfBeaconData>