Edit Area

Edit area of a project.

Description

This action allows you to edit an existing area within a project by providing the area UUID and new area name.

Request Topic

LYT/f7bdc7e7-1847-4c54-b1d4-64d3d0a833f7/AREA/ACTION

Request Payload

{
  "version":"v1.0",
  "action": "edit",
  "data": {
    "area_uuid":"6e45c90e-228f-4847-8350-cc9fc797fd2b",
    "area_name": "home updated"
  }
}

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 "edit")
area_uuid	string	Yes	Area UUID should be like this : data > area_uuid
area_name	string	Yes	New area name should be like this : data > area_name

Response Topic

LYT/f7bdc7e7-1847-4c54-b1d4-64d3d0a833f7/AREA/E/ACTION

Response Payload

Success Response

{
  "message":"success",
  "version":"v1.0",
  "action":"edit",
  "data":{
    "area_uuid":"6e45c90e-228f-4847-8350-cc9fc797fd2b",
    "area_name":"home updated",
    "project_uuid":"f7bdc7e7-1847-4c54-b1d4-64d3d0a833f7"
  }
}

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

How to resolve:

1. Verify the project UUID is correct
2. Check if you have the necessary permissions
3. Ensure the project exists

2. Area Not Found Error (Code: 2003)

{
  "message": "error",
  "message_type": {
    "code": 2003,
    "message": "Area not found",
    "errorCode": "AREA_NOT_FOUND"
  }
}

When it occurs:

• The area UUID is invalid
• The area has been deleted
• The area doesn't belong to the specified project

How to resolve:

1. Verify the area UUID is correct
2. Check if the area exists in the project
3. Ensure the area hasn't been already deleted

3. Constraint Error (Code: 3005)

a. Area UUID Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "area_uuid must be a string",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

b. Area Name Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "area_name must be a string",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

c. Version Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "version must be one of the following values: v1.0",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

d. Action Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "action must be one of the following values: get, get-zones, get-nodes, get-scenes, get-groups, create, delete, edit",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

Constraint errors occur in the following cases:

1. Area UUID Constraints:

   • Area UUID must be a string
   • Area UUID field should not be empty
   • Area UUID field has incorrect type

2. Area Name Constraints:

   • Area Name must be a string
   • Area Name field should not be empty
   • Area Name field has incorrect type

3. Action Constraints:

   • Action must be one of: get, get-zones, get-nodes, get-scenes, get-groups, create, delete, update
   • Action field is missing
   • Action field has incorrect value

4. Version Constraints:

   • Version must be exactly "v1.0"
   • Version field is missing
   • Version field has incorrect format

Resolution:

• Always use "v1.0" as the version value
• Use "edit" as the action value
• Validate all parameters before sending

4. Cloud Not Activated Error (Code: 3010)

{
  "message":"error",
  "message_type":
    {
      "code":3010,
      "message":"Cloud not activated",
      "errorCode":"CLOUD_NOT_ACTIVATED"
    }
}

When it occurs:

• The Cloud connection is deactivated
• The Cloud connection is disconnected

How to resolve:

1. Verify the cloud is connected / activated.
2. Enable cloud connection.
3. Connect to the cloud.

Error Code Summary

Code	Error Code	Description	Solution
2002	PROJECT_NOT_FOUND	Project doesn't exists	Check project UUID valid or not
2003	AREA_NOT_FOUND	Area doesn't exists	Check area UUID valid or not
3005	CONSTRAINT_ERROR	Parameter validation failed	Check input values
3010	CLOUD_NOT_ACTIVATED	Cloud not activated	Check cloud connection