Climate Webservice

Get minimal environmental gateway states

Get list of basic states of all environmental gateways of an org

post/api/climate/getMinimalEnvironmentalGatewayStates

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/climate/getMinimalEnvironmentalGatewayStates
  • 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

ClimateGetMinimalEnvironmentalGatewayStatesWSRequest required

Request to retrieve minimal environmental gateway states.

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
lastEvaluatedKeystring nullable
warningMsgstring nullable

Example response

{
  "minimalEnvironmentalGatewayStates": [
    {
      "airQualityIndex": 45,
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "ch2oPpb": 15.7,
      "co2Ppm": 450,
      "coConcentration": 2.1,
      "connected": true,
      "createdAtMillis": 1640995200000,
      "defaultInterfaceMac": "00:1A:2B:3C:4D:5E",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "externalIPAddress": "203.0.113.1",
      "falsePositiveConfidencePercent": 5.2,
      "firmwareVersion": "2.1.5",
      "floorNumber": 2,
      "heatIndexDegF": 85.2,
      "iaq": 85.5,
      "latitude": 37.7749,
      "leakProbePresent": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Main Office Gateway",
      "nc0p5": 120.5,
      "nc10p0": 15.3,
      "nc1p0": 85.2,
      "nc2p5": 45.8,
      "nc4p0": 32.1,
      "noxIdx": 88.2,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pm10p0": 18.9,
      "pm1p0": 8.5,
      "pm2p5": 12.3,
      "pm4p0": 15.7,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pressure": 1013.25,
      "probeTempC": 24.5,
      "relHumid": 45.2,
      "serialNumber": "EG-123456789",
      "smokeConfidencePercent": 92.8,
      "smokeTobaccoConfidencePercent": 88.1,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tempC": 23.5,
      "tempProbePresent": true,
      "timestampMs": 1640995200000,
      "typPartSize": 2.8,
      "vapeConfidencePercent": 85.5,
      "vapeThcConfidencePercent": 72.3,
      "vocIdx": 125.5
    }
  ]
}

Changes

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