POST Device/IsAlive
Update QFlow and/or device lists to indicate that the device is still alive
Request Information
URI Parameters
None.
Body Parameters
DeviceStatusName | Description | Type | Additional information |
---|---|---|---|
DeviceId |
Device Id / Name / User Name |
string |
Max length: 50 |
InfoText |
Extra Information Text (ie 14% CPU; 80% HD) |
string |
Max length: 255 |
AlertText |
Alert Text (Screen one colour/Printer out of paper) |
string |
Max length: 255 |
LastPing |
Last server ping duration (duration in ms of last call to this service) |
integer |
None. |
IPAddress |
Client IP address (Internal Network IP) If external IP is different, that will be appended by the API with a comma separation |
string |
Max length: 80 |
Screen |
Thumbnail of screen capture (optional) |
Collection of byte |
None. |
Request Formats
application/json, text/json
{ "DeviceId": "sample string 1", "InfoText": "sample string 2", "AlertText": "sample string 3", "LastPing": 4, "IPAddress": "sample string 5", "Screen": "QEA=" }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Request for restart or config change
DeviceStatusCommandsName | Description | Type | Additional information |
---|---|---|---|
RestartRequested |
Device controller has been requested to restart. Request remains active for 15 mins. |
boolean |
None. |
ScreenshotRequested |
Device controller has been requested to take a screen shot |
boolean |
None. |
HostURLUpdated |
If not blank/empty, the Host URL needs to be updated into the controller. Request remains active for 15 mins. |
string |
Max length: 80 |
Response Formats
application/json, text/json
{ "RestartRequested": true, "ScreenshotRequested": true, "HostURLUpdated": "sample string 3" }