ZenSpace
  1. fan
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
          POST
        • Subscribe to Device Events
          GET
        • Action on IoT Device
          POST
        • Get Device Control
          POST
        • Get Device Instruction
          POST
      • 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 API V2.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 Supported Devices
    • ZenSpace Device Integration
  1. fan

Get Device Instruction

Developing
POST
/devices/{meeting_space_id}/device-instruction
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:
light
Example
{"device_type": "fan"}

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//device-instruction' \
--header 'X-API-Key: your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{"device_type": "fan"}'

Responses

🟢200OK
application/json
Successfully retrieved device status.
Body
response
object 
optional
Details about the fan.
device_instruction
object 
optional
Example:
{"device":"fan","instructions":"device instructions"}
Example
{
    "response": {
        "device_instruction": {
            "device": "fan",
            "instructions": "device instructions"
        }
    }
}
🟠404Record Not Found
🔴500Server Error
Modified at 2025-01-29 09:56:56
Previous
Get Device Control
Next
o3-sensor
Built with