# City

Represents the City entity within the PMS, including details such as the city's name, geographic location, and any associated properties or operational data. This entity is used to categorise and manage properties by location, enabling filtering and reporting based on city-level information.

## Retrieve list of cities

 - [GET /api/v3/cities](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/listallcities.md): Fetch a comprehensive list of cities available within the PMS. The response includes details for each city, such as its name, unique identifier, address, facilities, and operational status. Optional query parameters can be used to filter the results by criteria such as location, status, or associated city. This endpoint is useful for managing property inventories and facilitating searches across multiple cities.

## Create a new city

 - [POST /api/v3/cities](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/createcity.md): Creates a new city within the Property Management System (PMS) with the provided details. Cities 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 city. If the creation is successful, the newly created city's details will be returned. In case of an unexpected system error, a  will be triggered.

## Retrieve a city by id

 - [GET /api/v3/cities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/getcitybyid.md): Fetch detailed information about a specific city within the PMS using its unique identifier. The response includes the city's name, associated properties, and any relevant metadata. This endpoint is commonly used to retrieve location-specific data to support property management and reporting functions.

## Update an existing city

 - [PUT /api/v3/cities/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/city/updatecity.md): Updates an existing city within the Property Management System (PMS) with the provided details. Cities help in organizing properties, defining operational zones, and generating location-based insights. This endpoint is useful for modifying existing citys to reflect changes in geographical areas or operational zones. The request body should contain the updated details for the city. 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 city by Id

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