GET
https://api.realtime.report/v1/changes/get_setpoints
Authentication:
Get a list of all the setpoints with new values.
Parameters
INTEGER
Set the device of the setpoints. (required)
INTEGER
Get all the setpoints with updated values only. Default this is true. (optional)
Response
Returns data of the setpoints
201
application/json; charset=utf-8
String
The id of the tag
String
The name of the tag
Bool
True if this is a setpoint and false if we have only read access.
Bool
True if this is an alarm and false if we have only read access.
Variable
The current value of this tag.
Example
/*
* Example get tag - How to get tag information from the API
* https://api.realtime.report/v1/tags
*/
try {
/*
* Initialize the RealtimeReporter API SDK with your API key.
* See: https://realtime.report/developer
*/
require_once $_SERVER['DOCUMENT_ROOT'].'/vendor/autoload.php';
$reporter = new reporter_api ;
$reporter->set_api_key('YOUR API KEY');
/*
* Parameters:
* device_id : Int
* only_new_values : Bool
*/
$data = array();
$data['only_new_values'] = true ; // this is the default value
/*
* All data is returned in a tag opject
*/
$setpoints = $reporter->get_setpoints('device_id', $data);
/*
* In this example we print the data in json format on the page
*/
echo "Setpoints data";
echo json_encode($setpoints, JSON_PRETTY_PRINT);
} catch (Exception $e) {
echo "API call failed: " . htmlspecialchars($e->getMessage());
}
Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "82449b8e92eb4f678707",
"name": "Valve open",
"is_setpoint": true,
"is_alarm": false,
"value": true
},
{
"id": "d01d2ac3e1184deea8a7",
"name": "Big tank temp",
"is_setpoint": true,
"is_alarm": false,
"value": 88
},
{.....},
{.....}
]
Response Error
Returns an array with error information
230
application/json; charset=utf-8
Integer
The error code listed in a list below
String
The error message listed in a list below
Error Codes
1000
1001
1000
1001