Appendix G – VisualRF Location API
VisualRF provides the following location APIs:
Site Inventory: https://[amp_host]/visualrf/site.xml?site_id=...
•
You can find the site_id from the Floor Plan List query defined on the XML API page
•
This interface provides floor details including access points, walls, regions, surveys, etc.
•
The corresponding example XML and schema are attached in visualrf_site_inventory.*
Device Location: https://[amp_host]/visualrf/location.xml?mac=...
•
Provide the radio MAC of the client to locate.
•
The corresponding site where the user was placed will be provided along with the dimensions
•
If a client is heard on multiple floors, it will only be placed on the floor that contains the AP it is
associated with.
Sample Device Location Response
<visualrf:device_location version="1" xmlns:visualrf="www.airwave.com">
<device mac="00:13:02:C2:39:28" name="Peter"
site_id="4f674301-4b47-4ac6-8417-4eba3f7df3a6"
site_name="AirWave">
<site-width>124.51</site-width>
<site-height>161.14</site-height>
<x>82.50</x>
<y>37.50</y>
</device>
</visualrf:device_location>
Sample Site Inventory Response
<amp:amp_site_inventory version="1"
xmlns:amp=http://www.airwave.com
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<site id="b45e7a49-23b5-4db0-891a-2e60bff90d2c" version="677">
<name>Remax</name>
<uom>ft</uom>
<width>314.45</width>
<height>425.88</height>
<property name="site_owner" value="" format="" />
<property name="name" value="Remax" format="" />
<property name="installer" value="" format="" />
<property name="planner" value="" format="" />
<image type="background">
<filename>/var/airwave/snapshot/b45e7a49-23b5-4db0-891a
-2e60bff90d2c.677/background.jpg</filename>
<relative-url>/snapshot/b45e7a49-23b5-4db0-891a
-2e60bff90d2c.677/background.jpg</relative-url>
<pixel-width>1151</pixel-width>
<pixel-height>1557</pixel-height>
</image>
<image type="thumbnail">
58
Visual RF an d Visual RF Plan | User Guide