# Building

Represents the Building entity within the Property Management System (PMS). This includes comprehensive property details such as the building's name, address, facilities, operational attributes, and any associated metadata. The Building entity is essential for managing and integrating property data, ensuring accurate and up-to-date information for operational and administrative purposes.

## Retrieve list of buildings

 - [GET /api/v3/buildings](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/listallbuildings.md): Retrieve a list of all buildings managed within the PMS. The response includes essential information for each building, such as its unique ID, name, address, facilities, and operational status. Optional query parameters can be included to refine the results, such as filtering by city, operational status, or specific attributes. This endpoint is particularly useful for displaying a catalogue of properties, managing building records, or integrating building data with external systems.

## Create a new building

 - [POST /api/v3/buildings](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/createbuilding.md): Create a new building record in the property module of the PMS. The request body should contain the necessary details for the building, such as name, address, facilities, and operational attributes. Upon successful creation, the response will include the newly created building's details.

## Retrieve a building by ID

 - [GET /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getbuildingbyid.md): Fetch detailed information about a specific building within the PMS using its unique identifier. The response includes details such as the building's name, address, facilities, operational status, and any associated metadata. This endpoint is typically used to view or manage property-specific information.

## Update an existing building

 - [PUT /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/updatebuilding.md): Update an existing building record in the property module of the PMS. The request body should contain the updated details for the building, such as name, address, facilities, and operational attributes. Upon successful update, the response will include the updated building's details.

## Delete a building by ID

 - [DELETE /api/v3/buildings/{id}](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/deletebuildingbyid.md): Delete a specific building record from the property module of the PMS using its unique identifier. This operation will remove the building and all associated data from the system. If the specified building ID does not exist, a not found error will be returned.

## Get access Codes for a building

 - [GET /api/v3/buildings/{id}/accessCodes](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getaccesscodeforbuilding.md): Retrieve all access codes associated with a specific building record in the property module of the PMS. 

## Get custom fields for a building

 - [GET /api/v3/buildings/{id}/customFields](https://apidocs.resharmonics.com/apis/resharmonics-pms/building/getcustomfieldsforbuilding.md): Retrieve all custom fields associated with a specific building record in the property module of the PMS. The response includes a list of custom fields, each containing details such as field name, type, and value. This endpoint is useful for accessing additional information stored in custom fields that are not part of the standard building attributes.