====/api/getconfiguration====

===Usage===

This function returns details about the ARDI database - specifically, information regarding properties, relationships, and detailed instructions on how to display both.

===Details==

^Detail^Value^
|Group|Server|
|From Server Version|0.9.0|
|Permission|[[permission_guest|Public]]|
|Methods|GET or POST|

==Parameters==

^Parameter^Notes^Meaning^
|**format**|String (xml)|Either 'xml' or 'json'|

===Return Value===

The return value is an XML or JSON file that gives you information about...

^Element^Meaning^
|Profiles|A list of data profiles and their ID numbers.|
|Properties|A list of properties, their names and ID numbers, plus any special display options, such as a custom gradient or mapping between value and colour.|
|Relationships|A list of relationships, their names, ID numbers, colours and view options.|

===Examples===

==Request==

<code>
http://<servername>/s/<sitename>/api/getconfiguration
</code>

==Success (XML)==

<code>
<config>
  <relations>
    <relationship name="Location" id="2" upname="Inside" downname="Contains" passes="" colour="#FA68DA" type="heirachial" hideinwalker="yes"/>
    <relationship name="Type" id="3" upname="A Type Of" downname="Is Assigned To" passes="" colour="" type="category"/>
    <relationship name="Data" id="4" upname="Taken From" downname="Fed To" passes="" colour="" type="logical"/>
    <relationship name="Control" id="5" upname="Controled By" downname="Controls" passes="" colour="#c20ec5" type="logical"/>
...
  </relations>
  <properties>
    <property name="Equipment Tag" id="2" type="TAG"/>
    <property name="Address" id="3" type="ADDRESS"/>
    ...
    <property name="Temperature - AC Setpoint" id="23" type="MEASUREMENT">
       <display>
          <range type="fixed" min="17" max="27"/>
          <gradient stops="00ffff_65.4_%25__00ff00_84.3_%25__ffea00_100_%25"/>
       </display>
      </property>
      <property name="Water Usage" id="21" type="MEASUREMENT">
        <display>
          <range type="floating" min="0" max="100"/>
        </display>
      </property>
    </properties>
    <profiles>
       <profile name="Actual" id="1" port="8085"/>
    </profiles>
</config>
</code>

==Success (JSON)==

<code>
[{
	"relations": [{
		"relationship": [{
			"name": "Location",
			"id": "2",
			"upname": "Inside",
			"downname": "Contains",
			"passes": "",
			"colour": "#FA68DA",
			"type": "heirachial",
			"hideinwalker": "yes"
		}, {
			"name": "Type",
			"id": "3",
			"upname": "A Type Of",
			"downname": "Is Assigned To",
			"passes": "",
			"colour": "",
			"type": "category"
		}, {
			"name": "Data",
			"id": "4",
			"upname": "Taken From",
			"downname": "Fed To",
			"passes": "",
			"colour": "",
			"type": "logical"
		}, {
			"name": "Control",
			"id": "5",
			"upname": "Controled By",
			"downname": "Controls",
			"passes": "",
			"colour": "#c20ec5",
			"type": "logical"
		}, {
			"name": "Monitors",
			"id": "6",
			"upname": "Monitored By",
			"downname": "Monitors",
			"passes": "",
			"colour": "#22FF22",
			"type": "physical"
		}, {
			"name": "HVAC Feed",
			"id": "17",
			"upname": "Is fed from",
			"downname": "Feeds",
			"passes": "",
			"colour": "#7269f1",
			"type": "physical"
		}]
	}],
	"properties": [{
		"property": [{
			"name": "Equipment Tag",
			"id": "2",
			"type": "TAG"
		}, {
			"name": "Address",
			"id": "3",
			"type": "ADDRESS"
		}, {
			"name": "Area of Effect",
			"id": "4",
			"type": "AOE"
		}, {
			"name": "Signs",
			"id": "5",
			"type": "WARNINGS"
		}, {
			"name": "Layout",
			"id": "9",
			"type": "LAYOUT"
		},  {
			"name": "Days To Inspection",
			"id": "27",
			"type": "MEASUREMENT",
			"display": [{
				"range": [{
					"type": "floating",
					"min": "0",
					"max": "365"
				}]
			}, {
				"range": [{
					"type": "fixed",
					"min": "0",
					"max": "365"
				}],
				"gradient": [{
					"stops": "ff0000_0_%25__f7ff00_3.8_%25__3bff00_7.7_%25__00680f_100_%25"
				}]
			}]
		}, {
			"name": "Status - Door",
			"id": "28",
			"type": "ENUM",
			"enum": "0=Closed^1=Open^2=Fault"
		}, {
			"name": "Extinguisher Type",
			"id": "29",
			"type": "ENUM",
			"enum": "0=Unknown^1=CO2^2=Chem^3=Foam^4=Dry Powder"
		}, {
			"name": "Status - Switch",
			"id": "30",
			"type": "STATUS",
			"zero": "Off",
			"one": "On"
		}, {
			"name": "Status - Running",
			"id": "31",
			"type": "STATUS",
			"zero": "Stopped",
			"one": "Running"
		}, {
			"name": "Temperature - Surface",
			"id": "41",
			"type": "MEASUREMENT",
			"display": [{
				"range": [{
					"type": "floating",
					"min": "0",
					"max": "100"
				}]
			}, {
				"range": [{
					"type": "fixed",
					"min": "0",
					"max": "500"
				}],
				"gradient": [{
					"stops": "0000ff_0_%25__40ff00_10.3_%25__caffb8_76_%25__ffa02d_90_%25__ff0000_100_%25"
				}],
				"option": [{
					"name": "fadeother",
					"value": "false"
				}]
			}]
		}
	}],
	"profiles": [{
		"profile": [{
			"name": "Actual",
			"id": "1",
			"port": "8085"
		}]
	}]
}]
</code>