# Region

Represents Region entities within the Property Management System (PMS). Regions are used to categorize geographical areas for better management and reporting. This functionality helps in organizing properties, defining operational zones, and generating location-based insights. Regions can be used to optimize resource allocation, enhance guest experiences, and support strategic decision-making.

## Retrieve list of regions

 - [GET /api/v3/regions](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/listallregions.md): Fetch a paginated list of regions within the Property Management System (PMS). Regions help in organizing properties, defining operational zones, and generating location-based insights. The response includes a list of regions with relevant metadata. If an unexpected system error occurs, a  will be triggered.

## Create a new region

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

## Retrieve a region by Id

 - [GET /api/v3/regions/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/region/getregionbyid.md): Fetch detailed information about a specific region within the Property Management System (PMS) using its unique ID. Regions help in organizing properties, defining operational zones, and generating location-based insights. This endpoint is useful for retrieving region-specific data for reporting, resource allocation, and strategic decision-making. The response includes details about the region, including its classification and associated metadata. If the specified region ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

## Update an existing region

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

## Delete a region by Id

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