Get Scenes
Get all scenes in a project.
Description
This action allows you to retrieve all scenes within a project, including:
- Scene Number
- Scene Name
- Zone Information
Request Topic
LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/PROJECT/ACTION
Request Payload
{
"version": "v1.0",
"action": "get-scenes",
"limit": 2,
"offset": 1
}
Request Field Descriptions
| Field | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version identifier (must be "v1.0") |
| action | string | Yes | Action to perform (must be "get-scenes") |
| limit | number | No | Maximum number of records to return (default: 50) |
| offset | number | No | Number of records to skip (default: 0) |
Response Topic
LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/PROJECT/E/ACTION
Response Payload
Success Response
{
"message": "success",
"version": "v1.0",
"action": "get-scenes",
"data": [
{
"scene_number": 47637,
"scene_name": "test scene",
"zone_name": "Test 1",
"zone_address": 63035,
"models": [
{ "type": "dimmer", "count": 1 },
{ "type": "switch", "count": 1 }
]
},
{
"scene_number": 18661,
"scene_name": "Night",
"zone_name": "109",
"zone_address": 50238,
"models": [
{ "type": "cct", "count": 3 },
{ "type": "fan", "count": 2 }
]
}
]
}
Error Handling
1. Project Not Found Error (Code: 2002)
{
"message": "error",
"message_type": {
"code": 2002,
"message": "Project not found",
"errorCode": "PROJECT_NOT_FOUND"
}
}
When it occurs:
- The project UUID is invalid
- The project has been deleted
- The user doesn't have access to the project
How to resolve:
- Verify the project UUID is correct
- Check if you have the necessary permissions
- Ensure the project exists
- Contact system administrator if you should have access
Error Code Summary
| Code | Error Code | Description | Solution |
|---|---|---|---|
| 2002 | PROJECT_NOT_FOUND | Project doesn't exist | Check project UUID valid or not |