/api/asset/detail

Usage

This function is used to get detailed information about a particular asset.

This includes live information, media files and relationships that the asset has with its neighbours. It's the most complete information available about the asset.

If you only require properties, the function /api/asset/info is noticeably faster, as it doesn't have to fetch extended properties or media items.

Details

DetailValue
GroupAsset
From Server Version0.9.0
PermissionGuest
MethodsGET or POST
Parameters
ParameterNotesMeaning
assetNumberThe ID of the asset
artagNumberThe ID of the AR marker
formatString (xml)Either 'xml' or 'json'

Note that either asset or artag must be specified.

Examples

Call
http://ardiserver.com/api/getardetail?asset=5
Success (XML)
<?xml version="1.0" encoding="UTF-8"?>
<assets>
   <asset>
      <name>Site</name>
      <fullname>Site</fullname>
      <id>5</id>
      <description>This is your initial ARDI site</description>
      <isolation>
         <status>Unknown</status>
      </isolation>
      <upstreamalerts>no</upstreamalerts>
      <properties>
         <Address id="3" type="ADDRESS" name="Address" class="local" source="5" quality="good" group="">
            <address>18/2 Memorial Drive, Shellharbour City Center, NSW, Australia</address>
         </Address>
      </properties>
      <media />
      <alerts />
      <relationships>
         <related id="2" priority="301" name="Location" upname="Inside" downname="Contains">
            <to id="1" direction="upstream" name="Location" />
            <to id="43" direction="downstream" name="Switchroom" />
            <to id="44" direction="downstream" name="Workshop" />
            <to id="46" direction="downstream" name="Level One" />
            <to id="47" direction="downstream" name="Level Two" />
            <to id="49" direction="downstream" name="External" />
            <to id="94" direction="downstream" name="Mobile" />
         </related>
      </relationships>
      <zeroenergy>Yes</zeroenergy>
      <tags>
         <tag>Location</tag>
      </tags>
   </asset>
</assets>
Success (JSON)
{
	{
	"assets": [{
		"asset": [{
			"name": ["Site"],
			"fullname": ["Site"],
			"id": ["5"],
			"description": ["This is your initial ARDI site"],
			"isolation": [{
				"status": ["Unknown"]
			}],
			"upstreamalerts": ["no"],
			"properties": [{
				"Address": [{
					"id": "3",
					"type": "ADDRESS",
					"name": "Address",
					"class": "local",
					"source": "5",
					"quality": "good",
					"group": "",
					"address": ["18\/2 Memorial Drive, Shellharbour City Center, NSW, Australia"]
				}]
			}],
			"media": ["   "],
			"alerts": ["   "],
			"relationships": [{
				"related": [{
					"id": "2",
					"priority": "301",
					"name": "Location",
					"upname": "Inside",
					"downname": "Contains",
					"to": [{
						"id": "1",
						"direction": "upstream",
						"name": "Location"
					}, {
						"id": "43",
						"direction": "downstream",
						"name": "Switchroom"
					}, {
						"id": "44",
						"direction": "downstream",
						"name": "Workshop"
					}, {
						"id": "46",
						"direction": "downstream",
						"name": "Level One"
					}, {
						"id": "47",
						"direction": "downstream",
						"name": "Level Two"
					}, {
						"id": "49",
						"direction": "downstream",
						"name": "External"
					}, {
						"id": "94",
						"direction": "downstream",
						"name": "Mobile"
					}]
				}]
			}],
			"zeroenergy": ["Yes"],
			"tags": [{
				"tag": ["Location"]
			}]
		}]
	}]

}