ZenSpace
  1. lock
ZenSpace
  • ZenSpace Integration Documentation
  • ZenSpace General Architecture - Overview
  • ZenSpace API V1.0
    • Device Management
      • lock
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • camera
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Instruction
        • Get Device Control
      • light
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
        • Get Device Instruction
      • fan
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
        • Get Device Instruction
      • o3-sensor
        • temprature
          • Subscribe to Device Events Copy Copy
          • Get Device Status
        • buzzer
          • Get Device Status Copy
          • Action on IoT Device
        • occupancy
          • Get Device Status
        • ring-light
          • Action on IoT Device
          • Get Device Status
        • Get Device Instruction
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • meeting-room-display
        • Get Device Status
      • Get Device Instruction Copy
      • Fetch Associated Device Types
    • Bookings
      • Create, Update, or Cancel a Booking
      • Bulk Booking Operation
      • Check-in Operation
    • Meeting Space
      • Store Meeting Space Availability
      • Get the list of meeting spaces.
      • Get the state of a specific meeting space.
  • ZenSpace API V2.0
    • Device Management
      • lock
        • Get Device Status
          POST
        • Subscribe to Device Events
          GET
        • Action on IoT Device
          POST
        • Get Device Control
          POST
      • camera
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Instruction
        • Get Device Control
      • light
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
        • Get Device Instruction
      • fan
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
        • Get Device Instruction
      • o3-sensor
        • temprature
          • Subscribe to Device Events Copy Copy
          • Get Device Status
        • buzzer
          • Get Device Status Copy
          • Action on IoT Device
        • occupancy
          • Get Device Status
        • ring-light
          • Action on IoT Device
          • Get Device Status
        • Get Device Instruction
        • Get Device Status
        • Subscribe to Device Events
        • Action on IoT Device
        • Get Device Control
      • meeting-room-display
        • Get Device Status
      • Get Device Instruction Copy
        GET
      • Fetch Associated Device Types
        GET
    • Bookings
      • Create, Update, or Cancel a Booking
      • Bulk Booking Operation
      • Check-in Operation
    • Meeting Space
      • Store Meeting Space Availability
      • Get the list of meeting spaces.
      • Get the state of a specific meeting space.
  • ZenSpace Supported Devices
    • ZenSpace Device Integration
  1. lock

Get Device Status

Developing
POST
/devices/{meeting_space_id}/status
Device Management
Retrieve the current status, health, and specific device metrics.

Request

Path Params
meeting_space_id
string 
required
Header Params
X-API-Key
string 
required
API key for authentication.
Example:
your-api-key
Body Params application/json
device_type
string 
required
Example:
lock
Example
{"device_type": "lock"}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/devices//status' \
--header 'X-API-Key: your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{"device_type": "lock"}'

Responses

🟢200OK
application/json
Successfully retrieved device status.
Body
response
object 
optional
door feedback value
Example:
{"device":"lock","value":"open||closed","status":"online||offline"}
device
string 
optional
Type of device lock
Example:
lock
value
string 
optional
Value of door_lock_feedback
Examples:
openclosed
status
string 
optional
Status of lock
Examples:
onlineoffline
Example
{
    "response": {
        "device": "lock",
        "value": "open||closed",
        "status": "online||offline"
    }
}
🟠404Record Not Found
🔴500Server Error
Modified at 2025-05-09 12:02:07
Previous
lock
Next
Subscribe to Device Events
Built with