Put /api/v202305/admin/reportingSettings

Operation: SetReportingSettingsV202305 Permissions: ApplicationSettings (Manage)

Summary

Set the system reporting settings

Request Body Parameters

Content-Type: application/json

Type Reference: ReportingSettingRequest

Parameter Description Type
energyUnitId The energy unit identifier Required (defined) integer
costUnitId The cost unit identifier Required (defined) integer
floorAreaUnitId The floor area unit identifier Required (defined) integer
monthsToExcludeFromCharts Months to exclude from charts, including the current month.
Ex. If the current month is October,
A value of 0 will not exclude any months,
A value of 1 will exclude the month of October,
A value of 2 will exclude October and September,
A value of 3 will exclude October, September, and August,
A value of 13 will exclude October and the last full year of data. Must be between 0 and 13 Required (defined)		 integer

Request Body

{
  "energyUnitId": 1,
  "costUnitId": 1,
  "floorAreaUnitId": 1,
  "monthsToExcludeFromCharts": 1
}

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: ReportingSettingResponse

Parameter Description Type
energyUnit UnitChild
   unitId The unit identifier integer
   unitCode The unit code string
   unitInfo The unit info string
costUnit UnitChild
   unitId The unit identifier integer
   unitCode The unit code string
   unitInfo The unit info string
floorAreaUnit UnitChild
   unitId The unit identifier integer
   unitCode The unit code string
   unitInfo The unit info string
monthsToExcludeFromCharts Months to exclude from charts, including the current month.
Ex. If the current month is October,
A value of 0 will not exclude any months,
A value of 1 will exclude the month of October,
A value of 2 will exclude October and September,
A value of 3 will exclude October, September, and August,
A value of 13 will exclude October and the last full year of data.		 integer
costReportingUnitTaskGUId For internal use only. The task GUID of cost reporting unit post processing, only set when the cost reporting unit is changed in the Edit Reporting Settings API. string

Responses

HTTP 200

Body

Content Type: application/json
{
  "energyUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "costUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "floorAreaUnit": {
    "unitId": 1,
    "unitCode": "string",
    "unitInfo": "string"
  },
  "monthsToExcludeFromCharts": 1,
  "costReportingUnitTaskGUId": "string"
}