Get Zone

Get details of a zone by its UUID.

Description

This action allows you to retrieve project information including:

• Zone Name
• Zone Address
• Area Information

Request Topic

LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/ZONE/ACTION

Request Payload

{
  "version": "v1.0",
  "action": "get",
  "data": {
    "zone_address": 51507
  }
}

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")
zone_address	string	Yes	Zone Address should be like this : data > zone_address

Response Topic

LYT/41e0d6b2-37de-43d8-a348-4ba94853b6cd/ZONE/E/ACTION

Response Payload

Success Response

{
  "message": "success",
  "version": "v1.0",
  "action": "get",
  "data": [
    {
      "zone_name": "102",
      "zone_address": 51507,
      "area_uuid": "8067232e-b301-47c6-99d6-d4cf04369114",
      "area_name": "Taj hotel 1",
      "models": [
        { "type": "cct" }, 
        { "type": "switch" }
      ]
    }
  ]
}

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

How to resolve:

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

3. Constraint Error (Code: 3005)

a. Zone UUID Error

{
  "message": "error",
  "message_type": {
    "code": 3005,
    "message": "zone_address must be a number",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

b. Version Error

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

c. 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",
    "errorCode": "CONSTRAINT_ERROR"
  }
}

Constraint errors occur in the following cases:

1. Zone Address Constraints:

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

2. Action Constraints:

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

3. 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 "get" as the type value
• Ensure zone address is correct
• Validate all parameters before sending

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