Request

Request（中文版）

GroupedLocalName (required) text - max length (255)

A Grouped Device’s Name in Local Language. Alpha numeric, supporting special characters .,;()[]{}&_|'-/\

Regex: "^[ A-Za-z0-9.,;()\[\]{}&_|'-\/\\]*$"

Please use the format as below:

{Aggregator}-{Province}-{Date}{An auto-incremented numeric string that has 3 digits and starts with ‘1’}

ex: SEASolar-Singapore-20240516001

GroupedLocalName (required) text - max length (255)

分组设备中文名称。（必填)

Alpha 字符，支持特殊字符，比如.,;()[]{}&_|'-/

正则表达式："^[ A-Za-z0-9.,;()\[\]{}&_|'-\/\\]*$"

请使用以下格式：

{公司名称}-{省份}-{日期}{一个自动递增的3位数字字符串，以' 1 '开头}

例如：海电能源-新加坡-20240516001

GroupedEnglishName (required) text - max length (255)

A Grouped Device’s Name in English.

Please use the format as below:

{Aggregator}-{Province}-{Date}{An auto-incremented numeric string that has 3 digits and starts with ‘1’}

ex: SEASolar-Singapore-20240516001

GroupedEnglishName (required) text - max length (255)

分组设备英文名（必填）

请使用以下格式：

{公司名称}-{省份}-{日期}{一个自动递增的3位数字字符串，以' 1 '开头}

例如：SEASolar-Singapore-20240516001

CountryCode (required) text - max length (2)

2-character country alpha code. ISO-3166. Supported list below:

Country Code i.e. SG, CN, VN, MY, ID

CountryCode (required) text - max length (2)

国家代码（必填）

2个字符的国家代码，ISO-3166标准，支持的列表如下：

SG, CN, VN, MY, ID

新加坡，中国，越南，马来西亚， 印尼

Province (required) text - max length (20)

A Grouped Device’s Province.

For country: China, Vietnam, Malaysia. please use Reference Province Code belowReference Province Codes

For other country, please input the Province’s Name.

Province (required) text - max length (20)

分组设备的省份。（必填）

对于中国、越南、马来西亚，请使用以下的省份代码：Reference Province Codes

对于其他国家，请手动输入省份名字。

Timezone (optional) text

Time zone information.

Sample: UTC+08:00

Timezone (optional) text

时区（可选）

时区信息。

比如：UTC+08:00

GenerationDataFrequency (optional) text - enum (Daily, Monthly)

Generation Data Frequency on Grouped Device to indicate that this Grouped Device will send generation data by Daily or Monthly, default is Daily

GenerationDataFrequency (optional) text - enum (Daily, Monthly)（可选）

如果为Daily，则后续发电量需传每日的维度发送，如果为Monthly，则后续发电量按每月的维度发送，默认为Daily。

Devices (required) array of objects

A Grouped Device’s devices

Devices (required) array of objects

设备（必填）

该值是一个列表，可放入多个设备

一个设备的示例：

Devices[n].InstallationName (required) text - max length (255)

The installation name of a device represents the project device. This name must match the value stated on the Owner Declaration Form in the appendix table.

Please use the format as below:

{Aggregator}-{Province}-{An auto-incremented numeric string that has 6 digits and starts with ‘1’}

ex: SouthEastAsiaSolarDeveloper-Singapore-000001

Devices[n].InstallationName (required) text - max length (255)

设备名称（必填）

installation name代表设备名称，此名称必须与业主声明函（ODF）上的附录表上的设备名称具有相同的值。

请使用以下格式：

{公司名称}-{省份}-{一个自动递增的6位数字字符串，以' 1 '开头}

例如：ChinaSolarDeveloper-AnhuiSheng-000001

Devices[n].Address (required) text - max length (255)

Device’s physical address. Must be in English

Devices[n].Address (required) text - max length (255)

设备地址（必填, 只限英文）

代表设备的物理地址。

Devices[n].PostalCode (required) text - max length (100)

Device’s postal code.

Devices[n].PostalCode (required) text - max length (100)

设备邮编（必填）。

Devices[n].Latitude (required) decimal(2,6)

The co-ordinates must demonstrate the location of the device or device. These co-ordinates must belong in the country/province identified previously.

* Must be in range -90 <= Latitude<= 90

* Must be provided in Google coordinates standard

Sample: 1.523123

Devices[n].Latitude (required) decimal(2,6)

设备纬度（必填）（整数位最多2位，小数位最多6位）

坐标必须正确显示设备的位置，坐标必须属于之前确定的国家/省份。

• 纬度必须在（-90， 90）范围内

• 必须以谷歌坐标标准提供

例子：1.523123

Devices[n].Longitude (required) decimal(3,6)

The co-ordinates must demonstrate the location of the device or device. These co-ordinates must belong in the country/province identified previously.

* Must be in range -180 <= Longitude <= 180

* Must be provided in Google coordinates standard.

Sample: 110.523123

Devices[n].Longitude (required) decimal(3,6)

设备经度（必填）（整数位最多3位，小数位最多6位

坐标必须正确显示设备的位置，坐标必须属于之前确定的国家/省份。

• 经度必须在（-180， 180）范围内

• 必须以谷歌坐标标准提供

例子：110.523123

Devices[n].GridConnectionDate (required) text - format YYYY-MM-DD

The date when the device connected to the electrical grid and was commissioned. The grid connection date must not be in the future.

Devices[n].GridConnectionDate (required) text - format YYYY-MM-DD

设备的并网时间（必填）

格式：YYYY-MM-DD

代表设备连接到电网并投入使用的日期，这个日期不能是未来的日期。

Devices[n].OwnersDeclarationStartDate (required) text - format YYYY-MM-DD

Owner's Declaration Start Date: The date when permission begins for requesting issuance on behalf of a device owner. This date must be on or before the issuance request date.

Datetime in format: YYYY-MM-DD

Devices[n].OwnersDeclarationStartDate (required) text - format YYYY-MM-DD

设备的业主声明开始时间（必填）

格式：YYYY-MM-DD

业主声明开始发行电量的日期，必须等于或在实际发行电量的开始日期之前。

Devices[n].OwnersDeclarationEndDate (optional) text - format YYYY-MM-DD

Owner's Declaration End Date

Business rules:

• The date when permission ends for requesting issuance on behalf of a device owner. This date must be on or after the issuance request date.

• When “Owner’s Declaration End Date” is null means there is no limitation for issuance from the start date onwards.

• The value must be after the Devices[n].OwnersDeclarationStartDate

Datetime in format: YYYY-MM-DD

Devices[n].OwnersDeclarationEndDate (optional) text - format YYYY-MM-DD

设备的业主声明结束日期（可选）

业务规则：

• 代表业主声明结束发行电量的日期，必须等于或在实际发行电量的结束日期之后。

• 当“业主声明结束日期”为空时，表示自开始日期起不存在签发限制

• 该值必须在OwnersDeclarationStartDate之后。

格式：YYYY-MM-DD

Devices[n].Domestic (required) boolean

Indicates whether the installation is on a domestic property or not.

If this is "true", the device will be marked as Rooftop Residential.

If this is "false", the device will be marked as Commercial & Industrial.

Devices[n].Domestic (required) boolean

Domestic（必填）

代表是否户用设备。

如果为true，代表此设备为户用设备。

如果为false，代表此设备为商用设备。

Devices[n].FeedInTariff (optional) boolean - default (false)

Feed In Tariff

Business Rule: Value must be the same among the devices in the grouped device.

If the one device’s “Feed In Tariff” is true, all remaining devices in that Grouped Device must be true as well.

Devices[n].FeedInTariff (optional) boolean - default (false)

设备的上网电价补贴（可选）

业务规则：同个分组设备下的所有设备的该值必须相同。

如果有个设备的值为true，那个分组设备下的其他设备的值也要为true。

Devices[n].DeclarationFormFileId (required) uuid - max length(36)

Declaration form file’s file ID retrieved using the API.

[POST] Upload Document for Grouped Devices - PUBLIC API Documentation - Confluence (atlassian.net)

Rule:

• The file ID must be valid file.

• The accepted file types are not image file.

• Can share same file id among Grouped Devices

ex: be8728c0-e7f6-4ed2-845f-63bf31a39c76

Devices[n].DeclarationFormFileId (required) uuid - max length(36)

声明函文件ID（必填）

使用以下API获得声明函文件ID：

[POST] Upload Document for Grouped Devices - PUBLIC API Documentation - Confluence (atlassian.net)

规则：

• 声明函文件必须是合法的文件

• 文件类型不能是图片

• 对于分组设备下的多个设备，可以使用同个声明函文件ID。

例如：be8728c0-e7f6-4ed2-845f-63bf31a39c76

Devices[n].PercentageRenewable (optional) decimal(3,6) - default (0)

Device’s Percentage Renewable

Must be in range 0 <= value <= 100

Default value: 100

Devices[n].PercentageRenewable (optional) decimal(3,6) - default (0)

设备的可再生百分比（可选）

该值必须介于0到100之间。

Devices[n].Inverters (required) array of objects

The device’s inverters

Devices[n].Inverters (required) array of objects

设备的逆变器（必填）

该值是一个列表，可放入多个逆变器

一个逆变器的示例：

Devices[n].Inverters[m].RemoteInvId (required) - text - max length (100)

Remote Inverter Id

Rule: Inverters must not have duplicate entries

ex: INV1000000033862740

Devices[n].Inverters[m].RemoteInvId (required) - text - max length (100)

远程逆变器ID（必填）

客户创建的唯一逆变器 ID，以便用于推送电量数据。

规则：逆变器ID不可重复

例如：INV1000000033862740

Devices[n].Inverters[m].ElectronicSerialNumber (required) - text - max length (255)

Inverter Electronic Serial Number

Rule: Inverters must not have duplicate entries of Electronic Serial Numbers associated with the same Brand, identified either by Brand code or Other Brand Name.

Devices[n].Inverters[m].ElectronicSerialNumber (required) - text - max length (255)

逆变器序列号（必填）

规则：同一个品牌的逆变器的序列号不得重复。逆变器品牌以Brand code和Brand Name进行标识。

Devices[n].Inverters[m].BrandCode (required) - text - max length (20)

Inverter Brand Code. Getting the code from [GET] Query Inverter Brands

“If the Inverter Brand does not exist in the collection, please use Brand Code 'OT27' and input in Devices[n].Inverters[m].OtherBrandName below

Devices[n].Inverters[m].BrandCode (required) - text - max length (20)

逆变器品牌编码（必填）

从以下API获得品牌列表：[GET] Query Inverter Brands

如果您的逆变器不存在于列表中，请使用”OT27”作为品牌编码，并将逆变器名称输入到 Devices[n].Inverters[m].OtherBrandName字段。

Devices[n].Inverters[m].OtherBrandName (optional) - text - max length (255)

Inverter Brand Name

Leave this field as empty string

ex: Panasonic

Devices[n].Inverters[m].OtherBrandName (optional) - text - max length (255)

逆变器品牌名称（可选）

本字段默认为空。如果逆变器编码为“OT27”，则输入逆变器名称，比如：Panasonic。

Devices[n].Inverters[m].InstalledCapacity (required) - decimal(12,3)

Inverter Installed Capacity in kW. Maximum capacity 1000 kW (0.25MW)

• Must be in range: 0 < capacity <= 1000

• Only accepting 3 decimal places

Devices[n].Inverters[m].InstalledCapacity (required) - decimal(12,3)

逆变器安装容量（必填）

以KW为单位，最大容量为1000KW（0.25MW）

• 该值必须介于0到1000之间

• 最多只允许3个小数点。

Devices[n].Inverters[m].EffectiveStartDate (optional) -text - format YYYY-MM-DD

Inverter’s effective start date.

Rule:

• If this field is null or empty, then default value equal to device’s grid connection date;

• Must be on or after the device’s grid connection date;

• Cannot be the day in the future.

Datetime in format: YYYY-MM-DD

ex: 2023-01-10

Devices[n].Inverters[m].EffectiveStartDate (optional) -text - format YYYY-MM-DD

逆变器生效开始日期（可选）

规则：

• 如果此字段为空，则其默认值将等于设备的并网日期。

• 该日期必须大于或等于并网日期。

• 该日期不能是未来某一天。

格式：YYYY-MM-DD

例如：2023-01-10

Devices[n].Inverters[m].EffectiveEndDate (optional) - text - format YYYY-MM-DD

Inverter’s Effective End Date: The date set to indicate when the inverter has become inactive.

Rule:

• Must be on or after the device’s grid connection date;

• Must be after the inverter’s effective start date;

• Cannot be the day in the future;

• If the inverter has a value for the Effective End Date, it means the inverter is inactive; otherwise, it is active.

Datetime in format: YYYY-MM-DD

ex: 2024-01-10

Devices[n].Inverters[m].EffectiveEndDate (optional) - text - format YYYY-MM-DD

逆变器生效结束日期（可选）

逆变器的有效结束日期：一旦此字段被赋值，则表示该逆变器为已停用状态。

规则：

• 该日期必须在设备并网日期当天或之后

• 该日期必须在逆变器有效开始日期之后

• 该日期不能是未来某一天

• 如果逆变器的有效结束日期有值，则表示该逆变器是已停用状态；否则表示为使用中状态。

格式：YYYY-MM-DD

例如：2024-01-10

Devices[n].Inverters[m].ReplacedByRemoteInvId (optional) - text - max length (100)

Replaced Remote Inverter Id

Rule:

• Inverters must not have duplicate entries;

• The replaced by remote inverter Id and the faulty remote inverter Id must belong to the same device;

• The Effective End Date is required if the Replaced By Remote Inverter ID has a value.

• If replaced by remote inverter Id is empty and Effective End Date has a value, then the inverter is in an inactive status during rehash and can be replaced in the future.

• If replaced by remote inverter Id has a value, then the inverter is in a replaced status during rehash.

ex: INV1000000033862740

For guidelines on replacing a faulty inverter, please refer to the document below.

API guideline on the Effective Period

Devices[n].Inverters[m].ReplacedByRemoteInvId (optional) - text - max length (100)

替换为新的逆变器ID（可选）

规则：

• 逆变器ID不可重复

• 替换后的逆变器ID与被替换的逆变器ID必须属于同一设备。

• 如果ReplacedByRemoteInvId字段有值，则EffectiveEndDate字段为必填项

• 如果ReplacedByRemoteInvId字段为空且EffectiveEndDate有值，则该逆变器表示为已停用状态，可在Rehash系统替换新的逆变器。

• 如果ReplacedByRemoteInvId字段有值，则该逆变器表示为已替换状态，不可以再次替换。

  例如：INV1000000033862740

关于在接口中替换故障逆变器的指引，请参阅下面的文档。

API guideline on the Effective Period

Response Body

Data object

Application object with Id

具有设备注册 ID 的对象

Data.Id uuid

Object with application Id

设备注册ID

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

错误对象，请查看Getting Started - #Error Object获取更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。