Create Group

Create group of a zone.

Description

This action allows you to create a new group within a zone by providing the group name and zone address.

Request Topic

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

Request Payload

{
  "version":"v1.0",
  "action": "create",
  "data": {
    "group_name": "Living Room Lights",
    "zone_address": 65184
  }
}

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 "create")
group_name	string	Yes	Group name should be like this : data > group_name
zone_address	number	Yes	Zone address should be like this : data > zone_address

Response Topic

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

Response Payload

Success Response

{
  "message":"success",
  "version":"v1.0",
  "action":"create",
  "data":{
    "group_name": "Living Room Lights",
    "group_address": 57197,
    "zone_name": "103",
    "zone_address": 65184,
    "models": []
  }
}

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. Zone Not Found Error (Code: 2005)

{
  "message": "error",
  "message_type": {
    "code": 2005,
    "message": "Zone not found",
    "errorCode": "ZONE_NOT_FOUND"
  }
}

When it occurs:

• The zone address is invalid
• The zone has been deleted
• The zone doesn't belong to the specified project

How to resolve:

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

3. Constraint Error (Code: 3005)

a. Group Name Error

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

b. Zone Address Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "zone_address must be a number",
    "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, create, delete, edit",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

Constraint errors occur in the following cases:

1. Group Name Constraints:

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

2. Zone Address Constraints:

   • Zone Address must be a number
   • Zone Address field should not be empty
   • Zone Address field has incorrect type

3. Action Constraints:

   • Action must be one of: get, create, delete, edit
   • 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 "create" 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
2005	ZONE_NOT_FOUND	Zone doesn't exists	Check zone address valid or not
3005	CONSTRAINT_ERROR	Parameter validation failed	Check input values
3010	CLOUD_NOT_ACTIVATED	Cloud not activated	Check cloud connection