API guideline on the Effective Period

Owned by Xiaowei Chen
Last updated: Nov 08, 2024
2 min read

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0.1

Oct 9, 2024

Chen Xiaowei

  • Added Table of Contents.

  • Added Changelogs.

New Inverter request

Added new optional fields (EffectiveStartDate, EffectiveEndDate, ReplacedByRemoteInvId) for use when replacing faulty inverters.

添加了新的可选字段（有效开始日期、有效结束日期、替换为新的逆变器ID），用于在更换故障逆变器时使用。

Request

Request（中文版）

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

EffectiveStartDate (optional) text - format YYYY-MM-DD

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

规则：

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

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

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

格式：YYYY-MM-DD

例如：2023-01-10

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

EffectiveEndDate (optional) text - format YYYY-MM-DD

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

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

规则：

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

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

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

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

格式：YYYY-MM-DD

例如：2024-01-10

ReplacedByRemoteInvId (optional) - text - max length (100)

Replaced By 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

ReplacedByRemoteInvId (optional) - text - max length (100)

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

规则：

  • 逆变器ID不可重复

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

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

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

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

    例如：INV1000000033862740

Business Scenarios

Scenario 1

If an inverter is damaged during use and has already generated power data but has not yet been registered in the REDEX system, it is allowed to replace the damaged inverter with a new one during the device registration process. After successful registration, the damaged inverter can still issue the generation data it has generated.

在使用过程中，若逆变器损坏且已经产生电量，但尚未在 REDEX 系统中注册，此时允许在注册损坏的逆变器时同时替换为新的逆变器。注册成功后，损坏的逆变器仍可发行其已产生的电量。

Flow

 

Example request

"Inverters": [ // the faulty inverter { "RemoteInvId": "OldRM1000020003386274014", "ElectronicSerialNumber": "HW2343243244414", "BrandCode": "HW21", "OtherBrandName": "", "InstalledCapacity": 10.9, "EffectiveStartDate": "2022-01-01", "EffectiveEndDate": "2024-02-01", "ReplacedByRemoteInvId": "NewRM1000020898439275847" }, // the replaced by inverter { "RemoteInvId": "NewRM1000020898439275847", "ElectronicSerialNumber": "HW8984392758437", "BrandCode": "HW21", "OtherBrandName": "", "InstalledCapacity": 9.9, "EffectiveStartDate": "2024-02-02" } ]

Scenario 2

If a registered inverter in the Redex system fails during use, you can replace and register a new inverter in the Rehash system. Please contact our operations team for assistance.

当逆变器在使用过程中损坏且已在 REDEX 系统中注册时，可在 Rehash 系统中进行替换并注册新的逆变器。请联系与贵司对接的运营人员协助处理。