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

Create gateways

Create one or more gateways for a certain customer.

API endpoint

gateway/slcID of customer

Request method

POST

Request headers

-

Request URL parameters

-

Request content

EntityTypeNullableDescription
gatewayarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
hw_idstringnoslcHardwareID of gateway
namestringyesname of gateway
remarksstringyesremarks
coordsarray (coords)yeslocation
locationintyesslcID of node in group tree
ring_connectionboolyesring connection

coords

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

Request content: example

{
	"gateway": [{
		"hw_id": "D2D97996-D6C70E05-9FF55B21-4982BFFA",
		"name": "11"
	}, {
		"hw_id": "B2D97996-D6C70E05-9FF55B21-4982BFFA",
		"name": "12"
	}]
}

Response on sucess

Headers

200 OK

Content (example)

{
	"job": slcID of generated field communication job
}

Response on error

Headers

400 Bad Request

Content (example)

{
	"error": 2000
}

Error Codes

CodeDescription
2000Invalid slcHardwareID
2001Oubliette
5000job creation failed