This is an old revision of the document!


Old JSON Formats

The 2026 version of ARDI updated up a number of JSON API endpoints to be cleaner and more consistent - previously these endpoints converted XML to JSON, which ended up creating messy JSON structures that weren't very efficient.

/getconfiguration

This is the old format for the /api/getconfiguration function.

[{
	"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"
		}]
	}]
}]

This is the old format for the api/asset/search function.

{
	"results": [{
		"asset": [{
			"id": "175",
			"name": "AN6-2993 Drive",
			"ern": "",
			"fullname": "Main Office Lower Ground Slurry System Primary Pump AN6-2993 Drive"
		},
                {
			"id": "178",
			"name": "Primary Pump",
			"ern": "PU12-92B",
			"fullname": "Main Office Lower Ground Slurry System Primary Pump"
		}]
	}]
}

/assets/detail

This is the response from the /assets/detail function

{
	{
	"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"]
			}]
		}]
	}]

}