Tutorials & Guides

Third-Party Monitoring API

Web API (JSON over HTTP) for third-party monitoring of device status, temperature, and uptime.

1 Introduction

If you wish to monitor system status from 3rd party (custom) application, you can use raw web interface API to get devices status in JSON format.

2 Configuration

Go to Software Configuration and Enable web interface.

Tip

Remember to configure Windows Firewall to allow for incoming TCP requests on web interface port (the port by default is 8081).

3 Supported queries

3.1 GET: networkMonitor

This request is used by Network Dashboard application internally and it returns overall information about number of Action Center issues, application version and devices summary.

Request [GET]:

http://YOUR_IP_ADDRESS:8081/api/networkMonitor

Response:

{  "acIssuesCount": 6,  "devices": [    {      "deviceName": "3DoF (4A)",      "deviceStatus": 0,      "deviceStatusDescription": "",      "firmware": "157.4",      "serialNumber": "XXXXXX-XXXXXX-XXXXXX-XXXXXX",      "systemTemperature": "N/A",      "upTime": "2h 51m 21s"    }  ],  "fspmVersion": "2.138.14.0"}

If an error occurs, deviceStatusDescription will contain a full error description (ForceSeatPM displays in the same description in Devices window).

3.2 GET: devices

This request provides more detailed status of devices.

Request [GET]:

http://YOUR_IP_ADDRESS:8081/api/devices

Fields description [GET]:

http://YOUR_IP_ADDRESS:8081/api/help/devices

Response:

{  "devices": [    {      "deviceType": 110,      "errorCode": 0,      "errorComponentIndex": 0,      "featuresTr": "FSDI",      "firmwareVersion": "157.4",      "hardwareId": 54,      "hardwareName": "3DoF (4A)",      "id": 1,      "masterSerialNumber": "XXXXXX-XXXXXX-XXXXXX-XXXXXX",      "nodeId": 0,      "offline": 0,      "operationState": 10,      "parkingTr": "finished (normal)",      "paused": 0,      "referenceRun": 2,      "serialNumber": "YYYYYY-YYYYYY-YYYYYY-YYYYYY",      "statusTr": "OK",      "temperature": "N/A",      "upTime": "2h 49m 03s",      "workDays": 40,      "workTime": "75h 17m 00s"    }  ]}

If an error occurs, statusTr will contain a full error description (ForceSeatPM displays in the same description in Devices window).

3.3 GET: globalState

This request provides simplified overview status.

Request [GET]:

http://YOUR_IP_ADDRESS:8081/api/globalState

Fields description [GET]:

http://YOUR_IP_ADDRESS:8081/api/help/globalState

Response:

{  "activeProfileName": "SDK - Positioning",  "motionCompensationEnabled": 0,  "operatingStatus": 5,  "operatingStatusTr": "Connected - Parking",  "userCentered": 0,  "userParked": 0,  "userPaused": 0}