Buildings
Buildings represent the physical structures that are being insured on a premises in a commercial risk profile. On this page, we'll dive into the different buildings endpoints you can use to manage them programmatically.
The Building object
Building objects represent a single building in a commercial risk profile. They contain the following properties and relationships:
Commercial-only Properties
These properties are available only for commercial risk profiles.- Name
premise
- Type
- string
- Filterable
- Description
The UUID of the premise this building belongs to
- Name
number
- Type
- int
- Filterable
- Sortable
- Description
The building's number
- Name
description
- Type
- nullable string
- Filterable
- Sortable
- Description
A text description of the building
- Name
year_built
- Type
- nullable string
- Description
The year the building was built
- Name
number_stories
- Type
- nullable int
- Description
The building’s total number of floors or levels
- Name
floor_area
- Type
- nullable int
- Description
The building’s total square footage
- Name
construction
- Type
- nullable enum
- Filterable
- Sortable
- Description
The building’s construction type
- Name
Frame
- Description
- Frame
- Name
Joisted Masonry
- Description
- Joisted Masonry
- Name
Noncombustible
- Description
- Noncombustible
- Name
Masonry Noncombustible
- Description
- Masonry Noncombustible
- Name
Modified Fire Resistive
- Description
- Modified Fire Resistive
- Name
Fire Resistive
- Description
- Fire Resistive
- Name
occupancy
- Type
- nullable string
- Sortable
- Description
How the building is being used, whether it is owner-occupant or renter-occupied for homeowners and the number of families for which the building is designed
- Name
protection_class
- Type
- nullable string
- Description
A rating from 1-10, indicating how well the building is protected from fire. A class of 1 indicates the best protection, while a class of 10 indicates the worst protection
- Name
sprinkler
- Type
- nullable string
- Filterable
- Sortable
- Description
Does the building have a fire suppression sprinkler system? Possible values include: Yes, No, Partial.
- Name
flood_zone
- Type
- nullable string
- Description
Flood hazard areas identified on the Flood Insurance Rate Map are identified as a Special Flood Hazard Area (SFHA). Visit our help page for Flood Zone Rating Definitions.
- Name
itv
- Type
- nullable numeric-string
- Filterable
- Sortable
- Description
Insurance-to-value, the estimated full dollar cost to replace or restore the building
- Name
assessor
- Type
- nullable numeric-string
- Filterable
- Sortable
- Description
The assessed dollar value of the building for tax purposes
- Name
appraisal
- Type
- nullable numeric-string
- Filterable
- Sortable
- Description
The appraised dollar market value of the building
- Name
notes
- Type
- nullable string
- Description
Any additional notes or comments about the building
- Name
image
- Type
- nullable string
- Description
The URL of the building's image, if uploaded via the Wunderite UI
Meta
- Name
created
- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the building was created
- Name
updated
- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the building was last updated
- Name
has_property_data
- Type
- bool
- Filterable
- Description
When
true
, indicates the building has 3rd-party property data available
Commercial-only Relations
Learn more about including relations.- Name
attachments
- Type
- Attachment[]
- Name
attachments.uploader
- Type
- User
- Description
The user who uploaded the attachment
- Name
premise
- Type
- Premise
- Filterable
- Name
premise.address
- Type
- Address
- Filterable
- Sortable
- Name
subjects_of_insurance
- Type
- Subject of Insurance[]
List all buildings
This endpoint allows you to retrieve a paginated list of all buildings in the corresponding commercial risk profile.
Parameters
See the building object for a list of all available filters and sorts.
Searchable
You can search for buildings by providing a search query in the filter[search]
parameter.
The search query will be matched against a building's number, description, premise's description or address.
Request
curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/buildings \
-H "Authorization: Bearer {token}" \
-d filter[search]=Location \
-d per_page=50
Response
{ "data": [ { "object": "building", "uuid": "9f5e6609-4647-47b0-a8f0-02865e4053c4", "data": { "premise": "aee2f644-9b1d-4481-8735-19827528da15", "number": 1, "description": "Main Office", "year_built": "2005",
Create buildings
This endpoint allows you to create new buildings in the corresponding commercial risk profile.
At least one building object must be provided in the request body.
You can also create subjects of insurance in the same request if you provide the subjects_of_insurance
property.
Required properties
- Name
premise
- Type
- string
- Description
The premise UUID that the building should belong to
Optional properties
See all available properties in the building properties section.
- Name
number
- Type
- int
- Description
The building's number. When this property is not provided, the building will be assigned a number automatically.
- Name
subjects_of_insurance
- Type
- SubjectOfInsurance[]
- Description
An array of subject of insurance objects that should be created with the building
Request
curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/buildings \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "building",
"data": {
"premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
"number": 3,
"description": "Headquarters",
"year_built": "2000",
"number_stories": 2,
"floor_area": 10000,
"construction": "Joisted Masonry",
"protection_class": "P3, Protected 3",
"notes": "This is the main building"
}
}
]
}'
Response
{ "data": [ { "object": "building", "uuid": "3a102f25-c991-4105-9e0c-9e6239b6316f", "data": { "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8", "number": 3, "description": "Headquarters", "year_built": "2000",
Request with sub resources
curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/buildings?include=subjects_of_insurance \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "building",
"data": {
"premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
"number": 3,
"description": "Headquarters",
"year_built": "2000",
"number_stories": 2,
"floor_area": 10000,
"construction": "Joisted Masonry",
"protection_class": "P3, Protected 3",
"notes": "This is the main building",
"subjects_of_insurance": [
{
"object": "subject_of_insurance",
"data": {
"type": "b",
"amount": 1000000
}
}
]
}
}
]
}'
Response
{ "data": [ { "object": "building", "uuid": "a96f7e0a-5985-4ab3-b05e-d867de90b549", "data": { "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8", "number": 3, "description": "Headquarters", "year_built": "2000",
Update buildings
This endpoint allows you to perform bulk updates on buildings.
At least one building object must be provided in the request body. Each object must contain at least one property from the building properties section.
Properties that are not provided will not be updated.
To clear a property, provide a null
value.
Request
curl -X PATCH https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "building",
"uuid": "cd4c8998-430a-4f43-a48d-87f631eab1fb",
"data": {
"premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
"number": 2,
"description": "Datacenter",
"year_built": "2005",
"number_stories": 1,
"floor_area": 3800,
"construction": "Fire Resistive",
"occupancy": "Miscellaneous Commercial",
"protection_class": "P2, Protected 2",
"sprinkler": "1",
"flood_zone": "X",
"itv": null,
"assessor": "134527.00",
"appraisal": "1000000.00",
"notes": null,
"image": null
}
}
]
}'
Response
{ "data": [ { "object": "building", "uuid": "cd4c8998-430a-4f43-a48d-87f631eab1fb", "data": { "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8", "number": 2, "description": "Datacenter", "year_built": "2005",
Delete buildings
This endpoint allows you to bulk delete risk data, including buildings.
At least one building object must be provided in the request body to delete the corresponding building.
Required properties
- Name
object
- Type
- string
- Description
The object type of the data to delete. Must be
building
in this case
- Name
uuid
- Type
- string
- Description
The UUID of the building to delete
Request
curl -X DELETE https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "building",
"uuid": "cd4c8998-430a-4f43-a48d-87f631eab1fb"
}
]
}'
Response
{
"data": [
{
"object": "building",
"uuid": "cd4c8998-430a-4f43-a48d-87f631eab1fb",
"profile_type": "commercial"
}
]
}