Appearance
API endpoints β
Authentication β
Authentication is done via API code on the URL path in every endpoint call.
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}| Parameter | Description | Required |
|---|---|---|
| hash | Parameter identifying the caller. Must be used for every call. | Yes |
List of all endpoints for INVIPO API service
HTTP Status Code Summary
| Status Code | Description | Details |
|---|---|---|
| 200 | OK | Everything worked as expected. |
| 204 | No Content | The request was successful but there's no content to return. |
| 400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 | Unauthorized | No valid API key provided. |
| 403 | Forbidden | The API key doesn't have permissions to perform the request. |
| 404 | Not Found | The requested resource doesn't exist. |
| 409 | Conflict | The request conflicts with another request or there are no valid data. |
| 500, 502, 503, 504 | Server Errors | Something went wrong on our end. (These are rare.) |
Location list β
List all location β
This method returns a list of all locations associated with the user's hash.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locationsResponse
json
[
{
"uuid": "69687290-9793-46c8-b688-94791175e0b7",
"name": "Zilina"
}
]json
{}Location alarms β
List all alarms for specific location β
This method provides a list of all alarms for specific location associated with the user's hash for specific time period.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/alarms?timestamp={timestamp}typescript
timestamp = number; // Unix timestamp in milliseconds to filter alarms from that time onward. Max range is 5 days.Response
json
[
{
"code": "ALM_LC_NO_RESPONSE",
"instanceId": 2009,
"active": false,
"date": 1757206785000,
"rvoNumber": 121,
"rvoName": "RVO 121",
"lampNumber": 2009,
"lampName": "121.2009"
},
{
"code": "ALM_CONTROL_SUPPLY_FAIL",
"instanceId": 0,
"active": false,
"date": 1757109600733,
"rvoNumber": 143,
"rvoName": "RVO 143",
"lampNumber": null,
"lampName": null
}
]json
{}json
[]Alarm codes
| Code | Type | Meaning | Object |
|---|---|---|---|
| ALM_BREAKER_FAIL | Alarm | Breaker fail | RVO |
| ALM_CONTACTOR_FAIL | Alarm | Contactor fail | RVO |
| ALM_CONTROL_SUPPLY_FAIL | Alarm | Control supply fail | RVO |
| ALM_DOOR_OPEN | Warning | Door open | RVO |
| ALM_LINE_BREAKER_FAIL | Alarm | Line breaker fail | RVO |
| ALM_ACCU_DEAD | Warning | Empty accumulator | RVO |
| LC_LAMP_FAIL | Warning | Lamp fail | Lamp |
| LC_LAMP_DEAD | Alarm | Lamp dead | Lamp |
| ALM_LC_NO_RESPONSE | Alarm | LC no response | Lamp |
| OC_ALM_RVOC_COM_TIMEOUT | Alarm | Communication timeout | RVO |
| OC_ALM_RVOC_NO_CALENDAR_MODE | Warning | RVOC not in auto mode | RVO |
RVOs list β
List all RVOs β
This method provides a list of all RVOs associated with the user's hash for specific location.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/rvosResponse
json
[
{
"name": "RVO 036",
"number": 36,
"location": "Ε½ilina",
"lat": 49.18,
"lng": 18.73
}
]json
{}json
[]Lamp list β
List all lamps β
This method provides a list of all lamps associated with the user's hash for specific location.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/lampsResponse
json
[
{
"number": 2016,
"name": "004.2016",
"rvoNumber": 4,
"lat": 49.21,
"lng": 18.75
}
]json
{}json
[]Notes
- Lamps are cached on first request.
Smart devices list β
List all smart devices β
This method provides a list of all smart devices associated with the user's hash for specific location.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/smartResponse
json
[
{
"name": "SMART pohybovΓ½ senzor Δ.1/4",
"type": "motionSensor",
"lat": 49.19,
"lng": 18.72
}
]json
{}json
[]Notes
- Smart devices are cached on first request.
RVO status β
Get RVO status information β
This method provides information about specific RVO associated with the user's hash for specific location.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/rvos/{rvoNumber}/statusResponse
json
{
"name": "RVO 081",
"number": 81,
"location": "Ε½ilina",
"lat": 49.23,
"lng": 18.73,
"mode": "RVOC_CALENDAR",
"lastUpdated": 1751880596314,
"breakerOn": true,
"contractorOn": true,
"doorOpen": false,
"communicationOk": true,
"status": "OK",
"locationName": "Ε½ilina"
}typescript
status = "OK" | "ALARM" | "WARNING" | "DISCONNECTED";RVO measurements β
Get RVO measurements β
This method provides measurements from specific RVO associated with the user's hash for specific location and time period.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/rvos/{rvoNumber}/meas?timestamp={timestamp}typescript
timestamp = number; // Unix timestamp in milliseconds to filter measurements from that time onward. Max range is 5 days.Response
json
{
"rvoNumber": 94,
"measurements": [
{
"voltage": [ // in Volts
238.73, // L1
237.17, // L2
238.4 // L3
],
"current": [ // in Amperes
4.23, // L1
9.22, // L2
3.59 // L3
],
"timestamp": 1757196000000
}
]
}json
{}json
{}Lamp detail β
Get lamp information β
This method provides information about specific lamp associated with the user's hash for specific location.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/lamps/{lampNumber}Response
json
{
"number": 1021,
"name": null,
"rvoNumber": null,
"lat": null,
"lng": null,
"lightIntensity": null,
"power": null,
"timestamp": 1751716095333,
"status": "OK"
}json
{}Smart data β
Get data from smart device β
This method provides data from specific smart device associated with the user's hash.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/smart/{smartUuid}/dataResponse
json
[
{
// Smart device data fields vary by device type.
// See the smart data page for details.
// Sorted by timestamp ascending.
}
]json
json
{}Smart history β
Get historical data from smart device. β
This method provides historical data from specific smart device associated with the user's hash starting from a given timestamp. Case handling for 'from' parameter:
- If 'from' parameter is not provided, data from the last 24 hours is returned.
- If 'from' parameter is older than one day ago, it is set to one day ago.
- If 'from' parameter is in the future, a BAD_REQUEST response is returned.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/smart/{smartUuid}/history?from={timestamp}typescript
from = number; // Unix timestamp in milliseconds to filter historical data from that time onward.Response
json
[
{
// Smart device historical data fields vary by device type.
// See the smart data page for details.
// Sorted by timestamp ascending.
}
]json
json
{
// If 'from' parameter is in the future.
}json
{}Location scenarios β
List all scenarios for specific location β
This method provides a list of all scenarios for specific location associated with the user's hash.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/scenarios?active={true/false}typescript
// Optional parameter to filter scenarios by active status.
active = boolean;Response
json
[
{
"id": 0,
"name": "ZILINA_0",
"active": false,
"locationUuid": "69687290-9793-46c8-b688-94791175e0b7",
"description": "ZILINA_0_0%",
"lampNames": [
"001.1001",
"001.1002",
... more lamps ...
]
},
... more scenarios ...
]json
{}Scenario activation β
Activate specific scenario for specific location β
This method activates specific scenario for specific location associated with the user's hash.
Endpoint
http
https://lightnet.issk.sk/invipo-za/api/v1/{hash}/locations/{locationUuid}/scenarios/{scenarioId}json
{
"active": true // Set to true to activate the scenario, false to deactivate.
}Response
json
{
"active": false,
"scenarioId": 1
}json
{}