GetOrgConstitute - Energy Expert - Alibaba Cloud Documentation Center

This interface is used to obtain carbon inventory organization analysis data.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/carbon/emission/analysis/org

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
code	string	Yes	The enterprise code.	Z-20240115-2
year	integer	Yes	Year.	2024
moduleCode	string	No	Module code.	carbonInventory.check.scope_1_direct_ghg_emissions
moduleType	integer	Yes	Module type.	3

Response parameters

Parameter	Type	Description	Example
	object	The struct returned.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	OrgEmission	The data returned.

Examples

Sample success responses

JSONformat

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "name": "EnterpriseZ",
    "nameKey": "Z-20240115-4",
    "carbonEmissionData": 1.2,
    "weightingCarbonEmissionData": 2.3,
    "weightingRatio": 0.4,
    "ratio": 0.2,
    "weightingProportion": 0.3,
    "moduleEmissionList": [
      {
        "name": "Scope 1: Direct GHG emissions",
        "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
        "carbonEmissionData": 1.2,
        "ratio": 0.2,
        "description": ""
      }
    ],
    "subEmissionItems": [
      {
        "name": "EnterpriseZ",
        "nameKey": "Z-20240115-4",
        "carbonEmissionData": 1.2,
        "weightingCarbonEmissionData": 2.3,
        "weightingRatio": 0.4,
        "ratio": 0.2,
        "weightingProportion": 0.3,
        "moduleEmissionList": [
          {
            "name": "Scope 1: Direct GHG emissions",
            "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
            "carbonEmissionData": 1.2,
            "ratio": 0.2,
            "description": ""
          }
        ],
        "subEmissionItems": [
          {
            "name": "EnterpriseZ",
            "nameKey": "Z-20240115-4",
            "carbonEmissionData": 1.2,
            "weightingCarbonEmissionData": 2.3,
            "weightingRatio": 0.4,
            "ratio": 0.2,
            "weightingProportion": 0.3,
            "moduleEmissionList": [
              {
                "name": "Scope 1: Direct GHG emissions",
                "nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
                "carbonEmissionData": 1.2,
                "ratio": 0.2,
                "description": ""
              }
            ],
            "subEmissionItems": []
          }
        ]
      }
    ]
  }
}

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