slControl API

LogoutChangelog (26.08.2024)Legal notesBasic usageRequest EmulatorTroubleshooting
Global
Get list of accessible customersGet lookup tables for settingsGet lookup tables for devicesGet lookup tables for operationModeGet lookup tables for gatewaysGet lookup tables for jobsGet lookup tables for alerts
Customers
Get customer configurationUpdate customer configurationGet mesh network
Groups
Get group tree
Lamp switches
Get lamp switchesUpdate lamp switches
Luminaire points
Get luminaire pointsUpdate luminaire pointsCreate luminaire pointsDelete luminaire points
Devices
Get devicesGet device dataGet device stateUpdate device dataUpdate device operation stateGet operation modeUpdate operation modeDelete deviceDelete devices
Devices - Statistics/Logs
Get radar dataGet motion dataGet device energyGet environmental data
Gateways
Get gatewaysGet gateway dataCreate gatewaysDelete a gateway
Jobs
Get jobs state of a deviceGet job state by slcID
Alerts
Get alertsCreate alertsUpdate alerts

Get luminaire points

This request delivers all luminaire points of a certain customer.

API endpoint

luminairePoint/slcID of customer

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Response content

EntityTypeNullableDescription
customerarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
luminairePoint[]array (luminairePoint)nolist of luminaire points

luminairePoint

EntityTypeNullableDescription
idintnoslcID of luminaire point
namestringyesstring
fidstringyesfid
ownerstringyesowner
maintenancestringyesmaintenance
locationintyesslcID of node in group tree
coordsarray (coords)nolocation
devicesarray (devices)nolist of devices/lamps
street_numberstringyesstreet / house number
lotstringyeslot
remarksstringyesremarks
stateintyesoperation state: 0 (n.a.) | 1 (in operation) | 2 (standing idle) | 3 (projected)

coords

EntityTypeNullableDescription
latitudestringyeslatitude (WGS84)
longitudestringyeslongitude (WGS84)
xstringyesx (LV95)
ystringyesy (LV95)

devices

EntityTypeNullableDescription
devicearray (device)nolist of devices/lamps

device

EntityTypeNullableDescription
idintnoslcID of lamp
hw_idintnoslcAddress of device
serialstringyesserial number
namestringyesname

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<customer>
		<customer_id>122</customer_id>
		<luminairePoint>
			<id>19049</id>
			<name>Johann-Mutter-Str. 002</name>
			<location>2565</location>
			<coords>
				<latitude>48.0464807</latitude>
				<longitude>10.873231</longitude>
				<x>2856047.3818087396</x>
				<y>1327401.5943836542</y>
			</coords>
			<devices>
				<device>
					<id>18496</id>
					<hw_id>8525</hw_id>
					<serial>0478769</serial>
					<name>Johann-Mutter-Str. 002</name>
				</device>
			</devices>
		</luminairePoint>
		<luminairePoint>
			<id>23608</id>
			<name>Johann-Mutter-Str. 003</name>
			<location>2565</location>
			<coords></coords>
			<devices></devices>
		</luminairePoint>
	</customer>
</slControl>

Response: example in JSON

{
	"customer": {
		"customer_id": "122",
		"luminairePoint": [{
			"id": "19049",
			"name": "Johann-Mutter-Str. 002",
			"location": "2565",
			"coords": {
				"latitude": "48.0464807",
				"longitude": "10.873231",
				"x": "2856047.3818087396",
				"y": "1327401.5943836542"
			},
			"devices": {
				"device": {
					"id": "18496",
					"hw_id": "8525",
					"serial": "0478769",
					"name": "Johann-Mutter-Str. 002"
				}
			}
		}, {
			"id": "23608",
			"name": "Johann-Mutter-Str. 003",
			"location": "2565",
			"coords": {},
			"devices": {}
		}]
	}
}