Endpoints

The base URL will be https://siteaddress/api/v3/

All endpoints in the document are relative to this URL.

Authentication

In order to authenticate your request, in each request include the following in the request headers.

x-auth-password: password
x-auth-username: username

Rooms ¶

Room-related resources of Sensor API

Current Room ¶

The rooms where a sensor is located.

Get
GET`/sensors/current-room?sensorId={sensorId}`

Example URI

GET /sensors/current-room?sensorId=123456

URI Parameters

HideShow

sensorId: string (required) Example: 123456
The sensor’s unique ID

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ok",
  "response": [
    {
      "id": 1,
      "roomId": 1,
      "sensorUid": "123456",
      "startDate": "2020-09-14T16:30:19Z"
    }
  ]
}

Authentication ¶