EMS华光环能大屏定制接口接口文档

### 1. 站点信息接口 (`/api/station_info`)

**描述**：获取站点的基本信息，包括公司信息、地理坐标、以及功率和容量相关参数。

- **请求方法**：`GET`
- **URL**：`/api/station_info`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/station_info?accountNo=2023061609362885181
  ```

- **返回格式**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": {
          "createTime": "2024-11-06 22:18:45",
          "companyName": "企业264",
          "companyAddress": "地址318号",
          "longitude": "-166.043026",
          "latitude": "51.886282",
          "companyLeader": "负责人4238",
          "companyLeaderContact": "13943575409",
          "transformerCapacity": "22",
          "pvCapacity": "36",
          "currentPower": "243kW",
          "pvPower": "137kW",
          "stationCapacity": "115kVA",
          "pvStationCapacity": "212kVA"
      }
  }
  ```
- **返回字段说明**：

| 字段名                | 类型   | 说明                                           |
  |-----------------------|--------|------------------------------------------------|
  | `createTime`         | string | 数据创建时间，格式为`yyyy-MM-dd HH:mm:ss`。      |
  | `companyName`        | string | 企业名称。                                      |
  | `companyAddress`     | string | 企业地址。                                      |
  | `longitude`          | string | 企业所在位置的经度，格式为小数。                 |
  | `latitude`           | string | 企业所在位置的纬度，格式为小数。                 |
  | `companyLeader`      | string | 企业负责人姓名。                                |
  | `companyLeaderContact`| string| 企业负责人联系电话。                            |
  | `transformerCapacity` | string| 变电站数量（单位：台）。                         |
  | `pvCapacity`         | string | 光伏站数量（单位：台）。                         |
  | `currentPower`       | string | 当前总功率（单位：kW）。                         |
  | `pvPower`            | string | 当前光伏发电功率（单位：kW）。                   |
  | `stationCapacity`    | string | 电站装机容量（单位：kVA）。                      |
  | `pvStationCapacity`  | string | 光伏装机容量（单位：kVA）。                      |

---

### 2. 重点设备能耗排名接口 (`/api/important_device_energy_ranking`)

**描述**：获取重点设备的能耗排名列表。

- **请求方法**：`GET`
- **URL**：`/api/important_device_energy_ranking`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号
  - `groupId` (string, 可选): 分组ID

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/important_device_energy_ranking?accountNo=2023061609362885181&groupId=1
  ```

- **返回格式**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": [
          {
              "rank": 1,
              "equipmentName": "设备7",
              "power": "45"
          },
          {
              "rank": 2,
              "equipmentName": "设备7",
              "power": "69"
          },
          {
              "rank": 3,
              "equipmentName": "设备99",
              "power": "96"
          }
      ]
  }
  ```
- **返回字段说明**：

| 字段名         | 类型   | 说明                             |
  |----------------|--------|----------------------------------|
  | `rank`        | integer| 设备的排名，按能耗值从高到低排序。 |
  | `equipmentName`| string | 设备名称。                         |
  | `power`       | string | 设备的能耗分值。                   |

---

### 3. 总厂能耗接口 (`/api/total_energy_consumption`)

**描述**：获取总厂能耗的日、月、年数据，包括光伏、电、水、气等各类能耗。

- **请求方法**：`GET`
- **URL**：`/api/total_energy_consumption`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/total_energy_consumption?accountNo=2023061609362885181
  ```

- **返回格式**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": {
          "solarDaily": "1936.86",
          "solarMonthly": "146033.73",
          "solarYearly": "2379710.57",
          "electricityDaily": "2485.95",
          "electricityMonthly": "103550.60",
          "electricityYearly": "2184630.76",
          "waterDaily": "283.63",
          "waterMonthly": "1199.49",
          "waterYearly": "4105767.64",
          "gasDaily": "2915.40",
          "gasMonthly": "202747.14",
          "gasYearly": "1588014.76"
      }
  }
  ```
- **返回字段说明**：

| 字段名                 | 类型   | 说明                                      |
  |------------------------|--------|-------------------------------------------|
  | `solarDaily`          | string | 日光伏能耗（单位：kWh）。                  |
  | `solarMonthly`        | string | 月光伏能耗（单位：kWh）。                  |
  | `solarYearly`         | string | 年光伏能耗（单位：kWh）。                  |
  | `electricityDaily`    | string | 日用电能耗（单位：kWh）。                  |
  | `electricityMonthly`  | string | 月用电能耗（单位：kWh）。                  |
  | `electricityYearly`   | string | 年用电能耗（单位：kWh）。                  |
  | `waterDaily`          | string | 日用水能耗（单位：t）。                    |
  | `waterMonthly`        | string | 月用水能耗（单位：t）。                    |
  | `waterYearly`         | string | 年用水能耗（单位：t）。                    |
  | `gasDaily`            | string | 日用气能耗（单位：m³）。                   |
  | `gasMonthly`          | string | 月用气能耗（单位：m³）。                   |
  | `gasYearly`           | string | 年用气能耗（单位：m³）。                   |
---

### 4. 日月年区域能耗接口 (`/api/region_energy_consumption`)

**描述**：获取指定区域的日、月、年能耗数据，包含多个分项能源类型的能耗。

- **请求方法**：`GET`
- **URL**：`/api/region_energy_consumption`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号
  - `groupId` (string, 必填): 分组ID
  - `energyId` (string, 必填): 能源类型ID

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/region_energy_consumption?accountNo=2023061609362885181&groupId=1&energyId=1
  ```

- **返回格式**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": [
          {
              "region": "南厂区",
              "rootEnergyType": "水",
              "subEnergyConsumptions": [
                  {
                      "energyType": "天然气",
                      "dailyConsumption": "1633.84",
                      "monthlyConsumption": "120384.38",
                      "yearlyConsumption": "1239259.67"
                  },
                  {
                      "energyType": "氧气",
                      "dailyConsumption": "2442.37",
                      "monthlyConsumption": "65572.52",
                      "yearlyConsumption": "2144818.79"
                  }
              ]
          }
      ]
  }
  ```
- **返回字段说明**：

| 字段名                   | 类型   | 说明                                       |
  |--------------------------|--------|--------------------------------------------|
  | `region`                | string | 区域名称，例如 "南厂区"。                   |
  | `rootEnergyType`        | string | 根能源类型，例如 "水"、"气"、"电"等。        |
  | `subEnergyConsumptions` | list   | 包含多个分项能源类型的列表，每个元素包含以下字段： |
  
  子字段 `subEnergyConsumptions`：

| 字段名                | 类型   | 说明                                      |
  |-----------------------|--------|-------------------------------------------|
  | `energyType`         | string | 分项能源类型，例如 "天然气"、"氧气"等。       |
  | `dailyConsumption`   | string | 日能耗（单位：根据能源类型，可能是 m³、t 或 kWh）。|
  | `monthlyConsumption` | string | 月能耗（单位：同上）。                        |
  | `yearlyConsumption`  | string | 年能耗（单位：同上）。                        |

---

### 5. 日月年曲线图数据接口 (`/api/curve`)

**描述**：获取日、月、年曲线图数据，包含发电曲线、用能趋势、光伏消纳比。

- **请求方法**：`GET`
- **URL**：`/api/curve`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号
  - `dateType` (integer, 必填): 日期类型，1=日，2=月，3=年

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/curve?accountNo=2023061609362885181&dateType=1
  ```

- **返回格式**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": [
          {
              "type": "powerGenerationCurve",
              "data": [
                  { "time": "00:00", "value": "90.69" },
                  { "time": "01:00", "value": "12.37" }
              ]
          },
          {
              "type": "energyUsageTrends",
              "data": [
                  { "time": "00:00", "value": "34.69" },
                  { "time": "01:00", "value": "69.99" }
              ]
          },
          {
              "type": "solarEnergyRatio",
              "data": [
                  { "time": "00:00", "value": "50.89" },
                  { "time": "01:00", "value": "34.52" }
              ]
          }
      ]
  }
  ```
- **返回字段说明**：

| 字段名                | 类型   | 说明                                             |
  |-----------------------|--------|--------------------------------------------------|
  | `type`               | string | 数据类型，可能的值为 "powerGenerationCurve"、"energyUsageTrends" 和 "solarEnergyRatio"。|
  | `data`               | list   | 时间序列数据列表，每个元素包含以下字段：              |
  
  子字段 `data`：

| 字段名  | 类型   | 说明                                 |
  |---------|--------|--------------------------------------|
  | `time` | string | 时间刻度，根据 `dateType` 不同而不同：  |
  |         |        | - `1`（日）：`"00:00"`、`"01:00"`，表示小时级数据|
  |         |        | - `2`（月）：`"01"`、`"02"`，表示每天的数据 |
  |         |        | - `3`（年）：`"1"`、`"2"`，表示每月的数据 |
  | `value`| string | 曲线图对应的值，单位依赖于 `type` 类型： |
  |         |        | - "powerGenerationCurve"：单位为 kW     |
  |         |        | - "energyUsageTrends"：单位为 kW       |
  |         |        | - "solarEnergyRatio"：单位为 %         |
---

### 重点设备能耗排名-下拉框接口 (`/api/important_device_energy_ranking_select`)

**描述**：获取重点设备能耗排名的分组下拉框选项，用于展示设备的分组名称和分组ID，以便前端显示在下拉框中选择。

- **请求方法**：`GET`
- **URL**：`/api/important_device_energy_ranking_select`
- **请求参数**：
  - `accountNo` (string, 必填): 企业编号，用于标识企业。
  - `token` (string, 可选): 用户认证的 token，用于验证请求权限。

- **示例请求**：
  ```
  GET http://{{ip}}:{{port}}/{{root}}/HGHNCustomDashboard/api/important_device_energy_ranking_select?accountNo=2023061609362885181
  ```

- **返回字段说明**：

| 字段名      | 类型   | 说明                                |
  |-------------|--------|-------------------------------------|
  | `groupName` | string | 分组名称，表示设备所属的分组名称。    |
  | `groupId`   | string | 分组ID，用于唯一标识设备分组。        |

- **示例返回**：
  ```json
  {
      "code": 200,
      "msg": "查询成功",
      "data": [
          {
              "groupName": "分组名称1",
              "groupId": "1"
          },
          {
              "groupName": "分组名称2",
              "groupId": "2"
          }
      ]
  }
  ```

### 说明
- **`groupName`**：分组的名称，用于在前端下拉框中展示。
- **`groupId`**：分组的唯一标识符，便于选择和后续查询该分组下的设备能耗排名信息。