RErelynk
spaces

get latest status of spaces

get latest status of spaces

get/spaces/status

Request

  • Base URL
    https://api.relynk.io/v2.0.0
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Query parameters

customerIdstring uuid required

customer id context, id can be fetched from /customers endpoint

limitinteger

limit the number returned

offsetinteger

offset the returned list

order'asc' | 'desc'

order the returned list

sort'id' | 'name'

sort the returned list

namestring

filter by name

name__containsstring

filter by name contains

displayNamestring

filter by display name

displayName__containsstring

filter by display name contains

idstring uuid

filter by id

typestring

filter by type using brickschema/real estate core standard full uri.

subtypestring

filter by subtype using brickschema/real estate core standard full uri.

levelNumberinteger

filter by level number

isPartOfSpaceIdstring uuid

filter by is part of space id

path__containsstring

filter by path contains

includeOptionalFieldsstring[]

include status fields

Response

get status of spaces available

customerIdstring uuid required

customer id

idstring uuid required

space id

namestring nullable

space name

displayNamestring nullable

space display name

occupancynumber nullable

space occupancy

occupancyCountinteger nullable

space occupancy count

temperaturenumber nullable

space temperature

temperatureUnitstring nullable

space temperature unit

humiditynumber nullable

space humidity

humidityUnitstring nullable

space humidity unit

co2number nullable

space co2

co2Unitstring nullable

space co2 unit

tvocnumber nullable

space tvoc

tvocUnitstring nullable

space tvoc unit

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Meeting Room 1",
    "occupancy": 1,
    "occupancyUnit": "http://qudt.org/vocab/unit/UNITLESS",
    "occupancyCount": 10,
    "occupancyCountUnit": "http://qudt.org/vocab/unit/UNITLESS",
    "temperature": 20,
    "temperatureUnit": "http://qudt.org/vocab/unit/DEG_C",
    "co2": 400,
    "co2Unit": "http://qudt.org/vocab/unit/PPM"
  }
]

Changes

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