Skip to main content

Get Node

Get details of a node by its UUID.

Description

This action allows you to retrieve project information including:

  • Node Name
  • Node Address
  • Product ID (PID) and Version ID (VID)
  • Zone Information

Request Topic

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

Request Payload

{
"version": "v1.0",
"action": "get",
"data": {
"node_address": 26637
}
}

Request Field Descriptions

FieldTypeRequiredDescription
versionstringYesAPI version identifier (must be "v1.0")
actionstringYesAction to perform (must be "get")
node_addressnumberYesNode address should be like this : data > node_address

Response Topic

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

Response Payload

Success Response

{
"message": "success",
"version": "v1.0",
"action": "get",
"data": {
"node_name": "LYTIVA_A0A8E6",
"product_id": "A008",
"version": "0269",
"node_address": 1312,
"zone_name": "Test 1",
"zone_address": 63035,
"elements": [
{
"type": "dimmer",
"element_name": "Dimmer 1",
"unicast_address": 1317,
"node_address": 1312,
"groups": [
{
"group_address": 55722,
"group_name": "Test grp 2"
}
],
"scenes": [
{
"scene_number": 47637,
"scene_name": "test scene",
"configuration": { "dimming": 46 }
}
]
},
{
"type": "dimmer",
"element_name": "Dimmer 2",
"unicast_address": 1318,
"node_address": 1312,
"groups": [
{
"group_address": 59434,
"group_name": "test group "
},
{
"group_address": 55722,
"group_name": "Test grp 2"
}
],
"scenes": [
{
"scene_number": 33012,
"scene_name": "Night",
"configuration": { "dimming": 50 }
}
]
},
{
"type": "switch",
"element_name": "Master",
"unicast_address": 1312,
"node_address": 1312,
"groups": [],
"scenes": []
},
{
"type": "switch",
"element_name": "Switch 3",
"unicast_address": 1315,
"node_address": 1312,
"groups": [],
"scenes": [
{
"scene_number": 33012,
"scene_name": "Night",
"configuration": { "power": true }
}
]
},
{
"type": "switch",
"element_name": "Switch 1",
"unicast_address": 1313,
"node_address": 1312,
"groups": [
{
"group_address": 59434,
"group_name": "test group "
}
],
"scenes": [
{
"scene_number": 47637,
"scene_name": "test scene",
"configuration": { "power": false }
}
]
},
{
"type": "switch",
"element_name": "Switch 4",
"unicast_address": 1316,
"node_address": 1312,
"groups": [
{
"group_address": 55722,
"group_name": "Test grp 2"
}
],
"scenes": []
},
{
"type": "switch",
"element_name": "Switch 2",
"unicast_address": 1314,
"node_address": 1312,
"groups": [
{
"group_address": 55722,
"group_name": "Test grp 2"
}
],
"scenes": [
{
"scene_number": 33012,
"scene_name": "Night",
"configuration": { "power": true }
}
]
}
]
}
}

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

{
"message": "error",
"message_type": {
"code": 2028,
"message": "Node not found",
"errorCode": "NODE_NOT_FOUND"
}
}

When it occurs:

  • The node address is invalid
  • The node has been deleted

How to resolve:

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

3. Constraint Error (Code: 3005)

a. Node address Error

{
"message": "error",
"message_type": {
"code": 3005,
"message": "node_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",
"errorCode": "CONSTRAINT_ERROR"
}
}

Constraint errors occur in the following cases:

  1. Node Address Constraints:

    • Node Address must be a number
    • Node Address field should not be empty
    • Node Address field has incorrect type
  2. Action Constraints:

    • Action must be "get"
    • 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 group address is correct
  • Validate all parameters before sending

Error Code Summary

CodeError CodeDescriptionSolution
2002PROJECT_NOT_FOUNDProject doesn't existsCheck project UUID valid or not
2028NODE_NOT_FOUNDNode doesn't existsCheck node address valid or not
3005CONSTRAINT_ERRORParameter validation failedCheck input values