All Products
Search
Document Center

Energy Expert:GetEmissionSummary

Last Updated:Jul 01, 2024

Get a summary of carbon emissions.

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/summary

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

Request parameters.

codestringYes

The enterprise code.

C-20240119-1
yearintegerYes

Year of inventory.

2024
moduleTypeintegerNo

Module type.

3
moduleCodestringNo

Module code.

carbonInventory.check.scope_1_direct_ghg_emissions

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

dataobject

Details of summarized data

currentPeriodCarbonEmissionDatadouble

Statistical indicators for this cycle.

276.4
lastPeriodCarbonEmissionDatadouble

Last period statistical indicators.

9.40100
totalCarbonEmissionDatadouble

Total carbon emissions.

276.46
carbonSaveConversiondouble

Carbon emissions reduction.

0.0
ratiodouble

Year-on-year.

28.410
actualEmissionRatiodouble

Percentage of scheduled.

2.7657
weightingCarbonEmissionDatadouble

Calculate carbon emissions by share ratio

248.81400
lastPeriodWeightingCarbonEmissionDatadouble

Calculation of carbon emissions based on shareholding ratio in the last cycle.

8.4609
weightingRatiodouble

Year-on-year of weighting ratio carbon emissions.

28.4102
isWeightingboolean

Whether to show the weighting ratio carbon emission.

true
requestIdstring

Id of the request.

83A5A7DD-8974-5769-952E-590A97BEA34E

Examples

Sample success responses

JSONformat

{
  "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 timeSummary of changesOperation
2024-04-03The response structure of the API has changedView Change Details