Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Sites

Update Site using PUT method

Each site has 20 fields where you can define values associated. These custom data allow you to organize Arcadia data and tie them back to records in your system as well as enrich your synthetic intervals data. This is a PUT method, which requires all fields to be provided to ensure a complete update of the existing resource.

This endpoint supports Sandbox Mode.

put/plug/sites/{siteId}

Path parameters

siteIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

areainteger nullable

The area of the Site in square feet.

buildingType'FULL_SERVICE_RESTAURANT' | 'HOSPITAL' | 'LARGE_HOTEL' | 'LARGE_OFFICE' | 'MEDIUM_OFFICE' | 'OUTPATIENT' | 'PRIMARY_SCHOOL' | 'QUICK_SERVICE_RESTAURANT' | 'RETAIL_STANDALONE' | 'RETAIL_STRIPMALL' | 'SECONDARY_SCHOOL' | 'SMALL_HOTEL' | 'SMALL_OFFICE' | 'WAREHOUSE' | 'OTHER' nullable

The type of building.

buildingTypeGroup'EDUCATION' | 'FOOD_SERVICE' | 'HEALTHCARE' | 'LODGING' | 'MERCANTILE' | 'OFFICE' | 'WAREHOUSE_AND_STORAGE' | 'OTHER' nullable

The group of building types.

citystring

The city associated with the billing address.

countrystring

The country associated with the billing address.

facilityTypestring

Custom field for you to input site’s facility type. Deprecated in favor of buildingType.

heatingFuel'ELECTRICITY' | 'NATURAL_GAS' | 'PROPANE' | 'DISTRICT' | 'FUEL_OIL' | 'OTHER' | 'NONE' nullable

The type of heating fuel used in the Site.

hvacCoolType'CHILLER' | 'DIRECT_EXPANSION' | 'DISTRICT' | 'EVAPORATIVE' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable

The type of cooling system in the Site.

hvacHeatType'DISTRICT' | 'ELECTRIC_RESISTANCE' | 'FURNACE_OR_BOILER' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable

The type of heating system in the Site.

hvacVentType'ROOFTOP_UNIT' | 'ZONE_TERMINAL' | 'FORCED_AIR' | 'OTHER' | 'NONE' nullable

The type of ventilation system in the Site.

isLocationRecommendationIgnoredboolean

Indicates if a site has been opted out of address verification.

meterIdsstring[]

An array of unique identifiers for multiple meters.

numberOfStoriesinteger nullable

The number of stories of the Site.

postalCodestring

The postal code or ZIP code associated with the address of the account.

recipientstring

The recipient for the address. Deprecated because recipient is not useful for sites.

regionstring

The region or geographic area associated with the Site.

siteCodestring

A code or identifier assigned to a specific site.

siteNamestring

The name or label assigned to a specific Site.

siteNumberstring

The number or identifier assigned to a specific Site.

statestring

The state or province associated with the billing address of the account.

streetLine1string

The first line of the street address.

streetLine2string

The second line of the street address.

subRegionstring

A subregion or subdivision within a larger region, such as a county or district.

yearBuiltinteger nullable

The year the Site was built, ranging from 1 to the current year plus 10.

Response

OK

addressIssueType'INCOMPLETE_ADDRESS' | 'UNVERIFIED_ADDRESS' | 'VERIFIED_ADDRESS' nullable required

Issue type of a site's address.

areainteger nullable required

The area of the Site in square feet.

buildingType'FULL_SERVICE_RESTAURANT' | 'HOSPITAL' | 'LARGE_HOTEL' | 'LARGE_OFFICE' | 'MEDIUM_OFFICE' | 'OUTPATIENT' | 'PRIMARY_SCHOOL' | 'QUICK_SERVICE_RESTAURANT' | 'RETAIL_STANDALONE' | 'RETAIL_STRIPMALL' | 'SECONDARY_SCHOOL' | 'SMALL_HOTEL' | 'SMALL_OFFICE' | 'WAREHOUSE' | 'OTHER' nullable required

The type of building.

buildingTypeGroup'EDUCATION' | 'FOOD_SERVICE' | 'HEALTHCARE' | 'LODGING' | 'MERCANTILE' | 'OFFICE' | 'WAREHOUSE_AND_STORAGE' | 'OTHER' nullable required

The group of building types.

createdAtstring date-time nullable required

A timestamp indicating when the entity was created.

createdBystring nullable required

User or system responsible for creating the entity.

facilityTypestring nullable required

Custom field for you to input site’s facility type. Deprecated in favor of buildingType.

heatingFuel'ELECTRICITY' | 'NATURAL_GAS' | 'PROPANE' | 'DISTRICT' | 'FUEL_OIL' | 'OTHER' | 'NONE' nullable required

The type of heating fuel used in the Site.

hvacCoolType'CHILLER' | 'DIRECT_EXPANSION' | 'DISTRICT' | 'EVAPORATIVE' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable required

The type of cooling system in the Site.

hvacHeatType'DISTRICT' | 'ELECTRIC_RESISTANCE' | 'FURNACE_OR_BOILER' | 'HEAT_PUMP' | 'OTHER' | 'NONE' nullable required

The type of heating system in the Site.

hvacVentType'ROOFTOP_UNIT' | 'ZONE_TERMINAL' | 'FORCED_AIR' | 'OTHER' | 'NONE' nullable required

The type of ventilation system in the Site.

idstring required

A unique identifier for the entity.

isLocationRecommendationIgnoredboolean required

Indicates if a site has been opted out of address verification.

lastModifiedAtstring date-time nullable required

The timestamp indicating when this resource was last modified.

lastModifiedBystring nullable required

The user or system that last modified this resource.

meterIdsstring[] nullable required

Deprecated: prefer listing Meters filtered by siteId. An array of unique identifiers for multiple meters. Null for non-root users.

numberOfStoriesinteger nullable required

The number of stories of the Site.

regionstring nullable required

The region or geographic area associated with the Site.

siteCodestring nullable required

A code or identifier assigned to a specific site.

siteNamestring nullable required

The name or label assigned to a specific Site.

siteNumberstring nullable required

The number or identifier assigned to a specific Site.

subRegionstring nullable required

A subregion or subdivision within a larger region, such as a county or district.

totalMetersinteger required

Total number of meters associated with this site.

yearBuiltinteger nullable required

The year the Site was built.