PUT /api/v202502/ghg/default

Updates default GHG settings with multi-factor support for new meters

EditDefaultGHGSettings_MultiFactorV202502
Use this endpoint to modify which GHG scopes and factors are assigned by default to new meters. Supports multiple factors per commodity. Only commodities included in the request are updated; unmentioned commodities retain current settings. Set ScopeCategoryId and DefaultFactor to null to remove a commodity’s default. “UseMeterAddress” factor type is only allowed for electric. Requires GHG Administrator Manage or Application Settings Manage permission.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

GHGasDefaultSettingRequestV202502
Property Description Type
createEmissionSourcesForMeters Do we want to an create emission source automatically when we create a new meter? Required (defined) boolean
defaultSettings The Commodity default settings Required GHGasDefaultSettingRequestCommodityChildV202502[]
GHGasDefaultSettingRequestCommodityChildV202502 properties
Property Description Type
commodityId The Commodity ID Required (defined) integer (int32)
defaultSettings The Commodity default settings Required GHGasDefaultSettingRequestScopeCategoryAndFactorChildV202502[]
GHGasDefaultSettingRequestScopeCategoryAndFactorChildV202502 properties
Property Description Type
defaultFactor GHGDefaultFactor
GHGDefaultFactor properties
Property Description Type
factorId The Greenhouse Gas Factor identifier Required when FactorType is set to specific factor Must be null when FactorType is set to use meter address integer (int32)
factorType The Greenhouse Gas Factor type. The valid values for this field are “use meter address” or “specific factor” Required One of ‘use meter address’, ‘specific factor’ string
scopeCategoryId The Greenhouse Gas Scope category identifier Required (defined) integer (int32)
Example Request Body application/json 
{  "createEmissionSourcesForMeters": false,  "defaultSettings": [
    {    "commodityId": 1,    "defaultSettings": [
      {      "defaultFactor": {},      "scopeCategoryId": 1
    }
    ]
  }
  ]
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

GHGasDefaultSettingResponseV202502
Property Description Type
createEmissionSourcesForMeters Do we want to an create emission source automatically when we create a new meter? boolean
defaultSettings The default commodity settings GHGasDefaultSettingResponseCommodityChildV202502[]
GHGasDefaultSettingResponseCommodityChildV202502 properties
Property Description Type
commodityCode The Commodity Code string
commodityIcon Icon
Icon properties
Property Description Type
code The icon code Must be between 0 and 64 characters Required when Color is set string
color The icon color Must be between 0 and 32 characters Required when Code is set string
commodityId The Commodity ID integer (int32)
commodityInfo The Commodity Info string
defaultSettings The Commodity default settings IGHGDefaultScopeCategoryAndFactor[]
IGHGDefaultScopeCategoryAndFactor properties
Property Description Type
defaultFactor GHGFactorV202210
GHGFactorV202210 properties
Property Description Type
factorCategory GHGFactorCategoryV202210
GHGFactorCategoryV202210 properties
Property Description Type
factorCategoryId The Factor Category identifier integer (int32)
factorCategoryInfo The Factor Category Info string
factorDescription The Factor Description string
factorId The Factor Identifier integer (int32)
factorInfo The Factor Info string
factorType The GHG Factor type. Values for this field can be “use meter address” or “specific factor” string
defaultScopeCategory GHGScopeCategoryV202210
GHGScopeCategoryV202210 properties
Property Description Type
scope GHGScopeV202210
GHGScopeV202210 properties
Property Description Type
scopeId The Scope Identifier integer (int32)
scopeInfo The Scope Info string
scopeCategoryDescription The GHG Scope Category Description string
scopeCategoryId The GHG Scope Category Identifier integer (int32)
scopeCategoryInfo The GHG Scope Category Info string
inUseByVendor Flag to indicate if the commodity is assigned to any meters boolean
Example Response application/json 
{  "createEmissionSourcesForMeters": false,  "defaultSettings": [
    {    "commodityCode": "string",    "commodityIcon": {      "code": "string",      "color": "string"
    },    "commodityId": 1,    "commodityInfo": "string",    "defaultSettings": [
      {      "defaultFactor": {},      "defaultScopeCategory": {}
    }
    ],    "inUseByVendor": false
  }
  ]
}