本接口用于获取碳盘查组织分析数据。
接口说明
本接口请求参数中的 code 为企业编码。
本接口获取的是请求参数 code 对应的企业的数据及其递归子级数据。
关于上述子级数据,其含义是,企业的子级企业的数据。
关于上述子级企业的数据,其包含在企业数据的 subEmissionItems 字段中。
关于上述的递归,其含义是,一直获取企业的子级数据,直到其没有子级企业为止。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
energy:GetOrgConstitute |
none |
*全部资源
|
无 | 无 |
请求语法
POST /api/v1/carbon/emission/analysis/org HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体参数。 |
|
| code |
string |
是 |
企业 code。 |
Z-20240115-2 |
| year |
integer |
是 |
年份。 |
2024 |
| moduleCode |
string |
否 |
模块编码。 |
carbonInventory.check.scope_1_direct_ghg_emissions |
| moduleType |
integer |
是 |
模块类型。 |
3 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结构体。 |
||
| requestId |
string |
请求 ID。 |
83A5A7DD-8974-5769-952E-590A97BEA34E |
| data | OrgEmission |
返回数据。 |
示例
正常返回示例
JSON格式
{
"requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
"data": {
"name": "企业1",
"nameKey": "Z-20240115-4",
"carbonEmissionData": 1.2,
"weightingCarbonEmissionData": 2.3,
"weightingRatio": 0.4,
"ratio": 0.2,
"weightingProportion": 0.3,
"moduleEmissionList": [
{
"name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
"nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
"carbonEmissionData": 1.2,
"ratio": 0.2
}
],
"subEmissionItems": [
{
"name": "企业1",
"nameKey": "Z-20240115-4",
"carbonEmissionData": 1.2,
"weightingCarbonEmissionData": 2.3,
"weightingRatio": 0.4,
"ratio": 0.2,
"weightingProportion": 0.3,
"moduleEmissionList": [
{
"name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
"nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
"carbonEmissionData": 1.2,
"ratio": 0.2
}
],
"subEmissionItems": [
{
"name": "企业1",
"nameKey": "Z-20240115-4",
"carbonEmissionData": 1.2,
"weightingCarbonEmissionData": 2.3,
"weightingRatio": 0.4,
"ratio": 0.2,
"weightingProportion": 0.3,
"moduleEmissionList": [
{
"name": "范围一:直接排放(企业生产经营过程产生的直接温室气体排放量)",
"nameKey": "carbonInventory.check.scope_1_direct_ghg_emissions",
"carbonEmissionData": 1.2,
"ratio": 0.2
}
],
"subEmissionItems": []
}
]
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。