Obtain the emission source composition.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
POST /api/v1/carbon/emission/analysis/constitute
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
body | object | No | The request parameters for the operation. | |
code | string | Yes | The enterprise code. | C-20240119-1 |
year | integer | Yes | Year of inventory. | 2024 |
moduleType | integer | Yes | Module type. | 3 |
moduleCode | string | No | Module code. | carbonInventory.check.scope_1_direct_ghg_emissions |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 time | Summary of changes | Operation |
---|---|---|
2024-04-03 | The response structure of the API has changed | View Change Details |