Get a summary of carbon emissions.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request syntax
POST /api/v1/carbon/emission/analysis/summary
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
body | object | No | Request parameters. | |
code | string | Yes | The enterprise code. | C-20240119-1 |
year | integer | Yes | Year of inventory. | 2024 |
moduleType | integer | No | Module type. | 3 |
moduleCode | string | No | Module code. | carbonInventory.check.scope_1_direct_ghg_emissions |
Response parameters
Examples
Sample success responses
JSON
format
{
"data": {
"currentPeriodCarbonEmissionData": 276.4,
"lastPeriodCarbonEmissionData": 9.401,
"totalCarbonEmissionData": 276.46,
"carbonSaveConversion": 0,
"ratio": 28.41,
"actualEmissionRatio": 2.7657,
"weightingCarbonEmissionData": 248.814,
"lastPeriodWeightingCarbonEmissionData": 8.4609,
"weightingRatio": 28.4102,
"isWeighting": true
},
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E"
}
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 |