Skip to main content

Get Areas

Get all areas in a project.

Description

This action allows you to retrieve all areas within a project, including:

  • Area UUID
  • Area Name
  • Project UUID

Request Topic

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

Request Payload

{
"version": "v1.0",
"action": "get-areas",
"limit": 2,
"offset": 1
}

Request Field Descriptions

FieldTypeRequiredDescription
versionstringYesAPI version identifier (must be "v1.0")
actionstringYesAction to perform (must be "get-areas")
limitnumberNoMaximum number of records to return (default: 50)
offsetnumberNoNumber 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-areas",
"data": [
{
"area_uuid": "0c8eff88-b535-44cb-94da-6d6241a6eac0",
"area_name": "My House",
"project_uuid": "41e0d6b2-37de-43d8-a348-4ba94853b6cd"
},
{
"area_uuid": "8067232e-b301-47c6-99d6-d4cf04369114",
"area_name": "Taj hotel",
"project_uuid": "41e0d6b2-37de-43d8-a348-4ba94853b6cd"
}
]
}

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:

  1. Verify the project UUID is correct
  2. Check if you have the necessary permissions
  3. Ensure the project exists
  4. Contact system administrator if you should have access

Error Code Summary

CodeError CodeDescriptionSolution
2002PROJECT_NOT_FOUNDProject doesn't existCheck project UUID valid or not