Place APIs

Get /api/v3/place/{placeId}

Operation: GetPlaceV3 Permissions: BuildingsAndOrganizations (View)

Retrieves one place

Put /api/v3/place/{placeId}

Operation: EditPlaceV3 Permissions: BuildingsAndOrganizations (Edit)

Edits a place

Delete /api/v3/place/{placeId}

Operation: DeletePlaceV3 Permissions: BuildingsAndOrganizations (Delete)

Deletes a place

Get /api/v3/place

Operation: GetPlacesV3 Permissions: BuildingsAndOrganizations (View) Paginated

Retrieves all places

Post /api/v3/place

Operation: CreatePlaceV3 Permissions: BuildingsAndOrganizations (Create)

Creates a place

Put /api/v3/place/{placeId}/udf

Operation: EditPlaceUDFsV3 Permissions: BuildingsAndOrganizations (Edit)

Edits user defined field / custom field values for a particular place

Get /api/v3/place/{placeId}/udf

Operation: GetPlaceUdfsV3 Permissions: BuildingsAndOrganizations (View)

Retrieves all user defined fields / custom fields for a particular place

Get /api/v3/place/{placeId}/size

Operation: GetPlaceSizesV3 Permissions: BuildingsAndOrganizations (View)

Retrieves all place size records for a particular place

Post /api/v3/place/{placeId}/size

Operation: CreatePlaceSizeV3 Permissions: BuildingsAndOrganizations (Edit)

Creates a place size version
If a preceding place size version exists, the preceding record’s end date will be changed to match the created record’s begin date
If a succeeding place size version exists the created records end date will match the succeeding version’s begin date

Put /api/v3/place/{placeId}/size

Operation: EditPlaceSizeListV3 Permissions: BuildingsAndOrganizations (Edit)

API endpoint which takes care of Create, Edit and Delete of new place sizes in bulk

Get /api/v3/place/{placeId}/size/{placeSizeId}

Operation: GetPlaceSizeV3 Permissions: BuildingsAndOrganizations (View)

Retrieves a place size record for a particular place

Delete /api/v3/place/{placeId}/size/{placeSizeId}

Operation: DeletePlaceSizeV3 Permissions: BuildingsAndOrganizations (Edit)

Delete a place size version
The preceding version’s end date will be shifted to the deleted record’s end date to prevent any gaps

Get /api/v3/place/placetype

Operation: GetPlaceTypesV3

Retrieves all place types

Post /api/v3/place/placetype

Operation: CreatePlaceTypeV3 Permissions: BuildingsAndOrganizations (Edit)

Create a place type

Get /api/v3/place/placetype/{placeTypeId}

Operation: GetPlaceTypeV3

Retrieves one place type

Put /api/v3/place/placetype/{placeTypeId}

Operation: EditPlaceTypeV3 Permissions: BuildingsAndOrganizations (Edit)

Edit a current place type

Delete /api/v3/place/placetype/{placeTypeId}

Operation: DeletePlaceTypeV3 Permissions: BuildingsAndOrganizations (Edit)

Deletes the place type

Get /api/v3/place/udf

Operation: GetPlacesUdfsV3 Permissions: BuildingsAndOrganizations (View) Paginated

Retrieves all user defined fields / custom fields for all places

Get /api/v3/place/{placeId}/group

Operation: GetPlaceGroupsV3 Permissions: BuildingsAndOrganizations (View)

Retrieves all Place Groups for a particular place by placeId

Put /api/v3/place/{placeId}/group

Operation: EditPlaceGroupMembershipV3 Permissions: BuildingAndMeterGroups (Edit)

Edits a place’s group memberships.
Note that all groups a place should belong to must be passed in. Passing in one group means that the place will belong to one group only,
even if it previously belonged to several.
Only manual groups assignments can be changed; auto groups are unaffected.

Get /api/v3/place/{placeId}/project

Operation: GetEnergyProjectsForPlaceV3 Permissions: BuildingsAndOrganizations (View)

Retrieves all Energy Projects for a particular place by placeId. For organizations it will be the rollup of its children’s energy projects

Put /api/v3/parentPlace/{parentPlaceId}/place

Operation: MovePlaceV3 Permissions: BuildingsAndOrganizations (Edit)

Move list of places to be under parentPlaceId

Operation: GetEnergyStarPlaceLinkV3 Permissions: BuildingsAndOrganizations (View)

Get the ENERGY STAR linking information for this place and its meters.
PmPropertyId and PmMeterId will be null if no link yet exists.

Operation: EditEnergyStarPlaceLinkV3 Permissions: BuildingsAndOrganizations (Edit)

Edit the ENERGY STAR linking information for this place and its meters.
Set PmPropertyId/PmMeterId to null to unlink a property/meter.
Set PmMeterId to -1 to auto-create a new meter.

Get /api/v3/place/{placeId}/energyStar/hierarchy

Operation: GetEnergyStarPlaceHierarchyV3 Permissions: BuildingsAndOrganizations (View)

Get this place’s ENERGY STAR child places

Get /api/v3/place/{placeId}/energyStar

Operation: GetEnergyStarPlaceV3 Permissions: BuildingsAndOrganizations (View)

Get the ENERGY STAR info for a place.

Get /api/v3/place/{placeId}/energyStar/metrics

Operation: GetEnergyStarPlaceMetricsV3 Permissions: BuildingsAndOrganizations (View)

Get the ENERGY STAR metrics for a place.

Put /api/v202302/place/{placeId}/watticsSite

Operation: EditWatticsSiteLinkV202302 Permissions: BuildingsAndOrganizations (Edit)

Edit SmartAnalytics (Wattics) data on a place

Operation: UnlinkPlacesAndChildMetersFromEnergyStarV202110 Permissions: BuildingsAndOrganizations (Edit)

Unlink a list of places and their child meters from ENERGY STAR

Put /api/v202110/place/energyStar/submissionType

Operation: UpdateEnergyStarSubmissionTypeV202110 Permissions: BuildingsAndOrganizations (Edit)

Update a list of places to be submitted to ENERGY STAR manually or automatically

Get /api/v202105/place/{placeId}/udf/{udfId}/download

Operation: DownloadPlaceCustomFieldFileV202105 Permissions: BuildingsAndOrganizations (View)

Download file for a place custom field