# Area

Area Entity from the Property Management System (PMS). Areas are part of the geography of the PMS and are used to define the location of properties, including their hierarchical structure within cities and regions.

## Retrieve list of areas

 - [GET /api/v3/areas](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/listallareas.md): Retrieve a list of areas within the Property Management System (PMS). This endpoint allows you to fetch details about various geographical areas, including their hierarchical structure within cities and regions. Areas are used to define the location of properties and are essential for organizing and managing properties effectively within the PMS.

## Create a new area

 - [POST /api/v3/areas](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/createarea.md): Creates a new area within the Property Management System (PMS) with the provided details. Areas help in organizing properties, defining operational zones, and generating location-based insights. This endpoint is useful for adding new areas to the system for better management and reporting. The request body should contain the necessary details for the new area. If the creation is successful, the newly created area's details will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve an area by Id

 - [GET /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/getareabyid.md): Retrieve the details of a specific area within the Property Management System (PMS) using its unique identifier. This endpoint allows you to fetch comprehensive information about a particular geographical area, including its hierarchical structure within cities and regions. Areas are essential for organizing and managing properties effectively within the PMS.

## Update an existing area

 - [PUT /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/updatearea.md): Updates an existing area within the Property Management System (PMS) with the provided details. Areas help in organizing properties, defining operational zones, and generating location-based insights. This endpoint is useful for modifying existing areas to reflect changes in geographical areas or operational zones. The request body should contain the updated details for the area. If the specified city ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Delete a area by Id

 - [DELETE /api/v3/areas/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/area/deleteareabyid.md): Deletes a specific area within the Property Management System (PMS) using its unique ID. Areas help in organizing properties, defining operational zones, and generating location-based insights. This endpoint is useful for removing areas that are no longer relevant or needed in the system. The area will be marked as deleted rather than permanently removed to maintain historical data integrity. If the specified area ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.