====/api/connect====

===Usage===

This function returns details about the ARDI server and its database configuration.

===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^
|Auth|If this is **no**, indicates that the server is in //guest mode// and does not require authentication to request simple data|
|Sites|A list of the sites available on the server (if supported and permitted)|
|Version|The internal database version of the server.|
|Services|What ARDI and internal services are available. This will include a list of contexts and which port number(s) any live data consolidators run on |
|Settings|Specific settings regarding the server, such as zero energy confirmation and isolation|

===Examples===

==Request==

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

==Success (XML)==

<code>
<ardi>
   <auth>no</auth>
   <sites>
	<subsite url="default">Primary Site</subsite>
	<subsite url="second">Secondary Site</subsite>
	<subsite url="ter">Tertiary Site</subsite>
   </sites>
   <name>Primary Site</name>
   <version>0.9.9c</version>
   <service name="web" port="80"/>
   <service name="data" port="8104"/>
   <service name="contextdata" id="1" context="Actual" port="8104"/>
   <setting name="zeroenergy">disabled</setting>
   <setting name="users">Unlimited</setting>
</ardi>
</code>

==Success (JSON)==

<code>
{
	"auth": "no",
	"sites": [{
			"url": "default",
			"name": "API Demo Server"
		}
	],
	"name": "TripleI",
	"version": "0.9.9e",
	"services": [{
			"name": "data",
			"port": "8079"
		},
		{
			"name": "contextdata",
			"port": "8079",
			"id": "1",
			"context": "Actual"
		},
		{
			"name": "web",
			"port": "80"
		}
	],
	"settings": [{
		"name": "isolation",
		"value": "disabled"
	}]

}
</code>