All Products
Search
Document Center

Energy Expert:GetEmissionSourceConstitute

Last Updated:Jul 01, 2024

Obtain the emission source composition.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/carbon/emission/analysis/constitute

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request parameters for the operation.

codestringYes

The enterprise code.

C-20240119-1
yearintegerYes

Year of inventory.

2024
moduleTypeintegerYes

Module type.

3
moduleCodestringNo

Module code.

carbonInventory.check.scope_1_direct_ghg_emissions

Response parameters

ParameterTypeDescriptionExample
object

Schema of response.

dataarray

Response parameters

ConstituteItem

The list of comstitute analysis.

requestIdstring

Id of the request

9bc20a5a-b26b-4c28-922a-7cd10b61f96f

Examples

Sample success responses

JSONformat

{
  "data": [
    {
      "enterpriseName": "EnterpriseA",
      "rawData": 1.2,
      "carbonEmissionData": 3.222,
      "ratio": 0.5,
      "nameKey": "carbonInventory.check.indirect_emissions_from_imported_electricity",
      "name": "Scope 1: Direct GHG emissions",
      "emissionSourceKey": "carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec",
      "emissionSource": "GEC",
      "dataUnit": "kWh",
      "envGasEmissions": [
        {
          "type": "1",
          "name": "CO₂",
          "gasEmissionData": 4.33,
          "carbonEmissionData": 1.2
        }
      ],
      "subConstituteItems": [
        {
          "enterpriseName": "EnterpriseA",
          "rawData": 1.2,
          "carbonEmissionData": 3.222,
          "ratio": 0.5,
          "nameKey": "carbonInventory.check.indirect_emissions_from_imported_electricity",
          "name": "Scope 1: Direct GHG emissions",
          "emissionSourceKey": "carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec",
          "emissionSource": "GEC",
          "dataUnit": "kWh",
          "envGasEmissions": [
            {
              "type": "1",
              "name": "CO₂",
              "gasEmissionData": 4.33,
              "carbonEmissionData": 1.2
            }
          ],
          "subConstituteItems": [
            {
              "enterpriseName": "EnterpriseA",
              "rawData": 1.2,
              "carbonEmissionData": 3.222,
              "ratio": 0.5,
              "nameKey": "carbonInventory.check.indirect_emissions_from_imported_electricity",
              "name": "Scope 1: Direct GHG emissions",
              "emissionSourceKey": "carbonInventory.check.by_electricity_properties/carbonInventory.check.wind_electricity/carbonInventory.check.gec",
              "emissionSource": "GEC",
              "dataUnit": "kWh",
              "envGasEmissions": [
                {
                  "type": "1",
                  "name": "CO₂",
                  "gasEmissionData": 4.33,
                  "carbonEmissionData": 1.2
                }
              ],
              "subConstituteItems": []
            }
          ]
        }
      ]
    }
  ],
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-03The response structure of the API has changedView Change Details