All Products
Search
Document Center

Energy Expert:GetGasConstitute

Last Updated:Jul 01, 2024

This interface is used to obtain gas composition analysis.

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/gas/constitute

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request parameters.

codestringYes

The enterprise code.

C-20240115-3
yearintegerYes

Year

2024
moduleTypeintegerYes

Module type.

3
moduleCodestringYes

Module code.

carbonInventory.check.scope_1_direct_ghg_emissions

Response parameters

ParameterTypeDescriptionExample
object

The struct returned.

requestIdstring

The request ID.

83A5A7DD-8974-5769-952E-590A97BEA34E
dataarray<object>

The data returned.

object
typeinteger

Gas Type

1
namestring

Name of gas

CO₂
gasEmissionDatadouble

Gas emissions

3.14
carbonEmissionDatadouble

Carbon emissions

3.14
ratiodouble

Proportion of carbon emissions. Example value: 0.5 (50%)

0.5

Examples

Sample success responses

JSONformat

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
  "data": [
    {
      "type": 1,
      "name": "CO₂",
      "gasEmissionData": 3.14,
      "carbonEmissionData": 3.14,
      "ratio": 0.5
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-06-12The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-04-03The response structure of the API has changedView Change Details