PlaceBenchmark APIs

Get /api/v3/placeBenchmark/setting

Operation: GetPlaceBenchmarkSettingsV3

Get all the place benchmark names and categories for the owner


Put /api/v3/placeBenchmark/setting

Operation: EditPlaceBenchmarkSettingsV3 Permissions: ApplicationSettings (Manage)

The user can edit the category and name for each benchmark
If a benchmark has not been configured, it is configured
User cannot delete a benchmark from this endpoint
If the benchmark dto is null or not passed the API will ignore it
If the benchmark dto is not null, the category and name are required


Delete /api/v3/placeBenchmark/{benchmarkIndicator}/setting

Operation: DeletePlaceBenchmarkSettingV3 Permissions: ApplicationSettings (Manage)

Delete the settings for the place benchmark defined by the benchmarkIndicator.
Deletes all corresponding place benchmark values that were defined for that indicator.
Updates user-defined autogroup membership for groups that contained filters for that indicator.


Get /api/v3/placeBenchmark/category

Operation: GetPlaceBenchmarkCategoriesV3

Get all place benchmark categories in the database


Put /api/v3/placeBenchmark/{benchmarkIndicator}/place/{placeId}

Operation: EditPlaceBenchmarkValuesV3 Permissions: BuildingsAndOrganizations (Edit)

Edit all values for a benchmark factor on a place


Get /api/v3/placeBenchmark/{benchmarkIndicator}/place/{placeId}/benchmarkValue

Operation: GetBenchmarkValuesV3 Permissions: BuildingsAndOrganizations (View)

Retrieves benchmark values for a place


Post /api/v3/placeBenchmark/{benchmarkIndicator}/place/{placeId}/benchmarkValue

Operation: CreatePlaceBenchmarkValueV3 Permissions: BuildingsAndOrganizations (Edit)

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


Delete /api/v3/placeBenchmark/{benchmarkIndicator}/place/{placeId}/benchmarkValue/{placeBenchmarkId}

Operation: DeleteBenchmarkValueV3 Permissions: BuildingsAndOrganizations (Edit)

Delete a single benchmark value.
If a preceding benchmark value exists, the preceding record’s end date will be changed to prevent any gaps in benchmark values


Put /api/v3/placeBenchmark/{benchmarkIndicator}/place/{placeId}/benchmarkValue/{placeBenchmarkId}

Operation: UpdatePlaceBenchmarkValueV3 Permissions: BuildingsAndOrganizations (Edit)

Updates a place benchmark value
If the begin date is being modified, the following will happen:
* Records that now precede and previously preceded this benchmark will have their end dates modified to prevent gaps in benchmarks
* If a succeeding benchmark value exists for the new begin date, the end date will be modified to match the succeeding benchmarks end date