Climate Webservice

Get climate events for environmental sensor

Get list of climate events for environmental sensor

post/api/climate/getClimateEventsForSensor

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/climate/getClimateEventsForSensor
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

createdAfterMsinteger nullable

Timestamp in milliseconds after which events should be retrieved

createdBeforeMsinteger nullable

Timestamp in milliseconds before which events should be retrieved

limitinteger nullable

Maximum number of events to return

sensorUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "createdAfterMs": 1640991600000,
  "createdBeforeMs": 1640995200000,
  "limit": 100,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "climateEvents": [
    {
      "baseStationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "bleDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "closeBaseStations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.