diff --git a/_data/webapi-b2b-changelog.yml b/_data/webapi-b2b-changelog.yml index b3c67c09..f28191f2 100644 --- a/_data/webapi-b2b-changelog.yml +++ b/_data/webapi-b2b-changelog.yml @@ -1,3 +1,9 @@ +- version: "3.19.3" + availability: in_use + release_date: 20 July 2025 + description: |- + **Remote API** + - Added Stop charge status and Charge end time - version: "3.19.2" availability: in_use release_date: 30 Jul 2024 @@ -566,4 +572,5 @@ description: |- #### `1st release (B2B)` * As delivered to Huawei regarding interfacing API - * As delivered to MPH/API team regarding public B2B API \ No newline at end of file + + * As delivered to MPH/API team regarding public B2B API diff --git a/_data/webapi-b2c-changelog.yml b/_data/webapi-b2c-changelog.yml index 5376e798..27f0e197 100644 --- a/_data/webapi-b2c-changelog.yml +++ b/_data/webapi-b2c-changelog.yml @@ -1,3 +1,9 @@ +- version: "4.17.3" + availability: in_use + release_date: 10 Jul 2025 + description: |- + **Remote API** + - Added Stop charge status and Charge end time - version: "4.17.2" availability: in_use release_date: 30 Jul 2024 @@ -106,4 +112,5 @@ availability: not_in_use release_date: 11 Apr 2019 description: |- - **First Release** \ No newline at end of file + + **First Release** diff --git a/assets/openapi/api-b2b.yaml b/assets/openapi/api-b2b.yaml index cf58b75b..056b1c6d 100644 --- a/assets/openapi/api-b2b.yaml +++ b/assets/openapi/api-b2b.yaml @@ -1982,6 +1982,27 @@ components: nextDelayedTime: description: Duration (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) until the next battery charging. type: string + chargingEndTime: + description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end + type: string + stopChargeStatus: + type: string + description: | + Status of delayed stop charge. + one of following enums status will be set: + | Enum | Description | + |----------|:-------------:| + | Deactivated | Function is deactivated | + | Activated | The function is activated, and the conditions to execute it are met. | + | Successful | The most recent stop charge was successful. | + | StopChargeFailed | Failed to stop charging. | + | ChargeEndTimeScheduleFailed| The programming of the end of charge failed; the charging should not stop at the requested time. | + enum: + - Deactivated + - Activated + - Successful + - StopChargeFailed + - ChargeEndTimeScheduleFailed schedule: properties: programs: @@ -3506,11 +3527,39 @@ components: type: string schedule: type: object - description: Charge scheduling. Only one of the two modes, programs or nexDelayedTime, should be provided. + description: | + Charge scheduling: only one of the three modes, ```programs```, ```nextDelayedTime/immediate```, or ```chargingEndTime/chargingEndTimeEnabled```, should be provided. + * ```chargingEndTimeEnabled ```and ```chargingEndTime``` Can be used together to set the end time. + * ```nextDelayedTime``` and ```immediate``` cannot be used together and are mutually exclusive. Mixing them will result in an error (HTTP 400). + Here are the possible combinations of start and end times with their respective settings: immediate start and end time enable toggle. + * ```nextDelayedTime``` and ```immediate``` + | nextDelayedTime | immediate | allowed | + | :------------------: | :-------------------: | :-------------------: | + | set |not set|yes | + | set |set to true/false|no | + | not set |set to true/false |yes | + + * ```chargingEndTime``` and ```chargingEndTimeEnabled``` + | chargingEndTime | chargingEndTimeEnabled | allowed | + | :------------------: | :-------------------: | :-------------------: | + | set |not set|yes | + | set |set to true / false|yes | + | not set |set to true/false |Yes, if the chargingEndTime has been set before; otherwise, it will raise an error (HTTP 400)| + * General rule: An empty schedule object will result in an error (HTTP 400). properties: nextDelayedTime: type: string description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of the next battery charging time. + immediate: + type: boolean + description : Determines if the charging will start immediately(```True```) or not. + example : true + chargingEndTime: + type: string + description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end + chargingEndTimeEnabled: + type: boolean + description: Enable or disable the programmed charge end time. programs: description: Scheduled charging programs list. type: array @@ -3539,7 +3588,7 @@ components: example : PT14H30M immediate: type: boolean - description : Determines if the charging will start immediately(```True```) or not. + description : Determines if the charging will start immediately(```true```) or not. example : true preferences: description: Set the charging preferences. diff --git a/assets/openapi/api-b2c.yaml b/assets/openapi/api-b2c.yaml index 0165d4c0..9dbeae6c 100644 --- a/assets/openapi/api-b2c.yaml +++ b/assets/openapi/api-b2c.yaml @@ -2309,6 +2309,28 @@ components: nextDelayedTime: description: Duration (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) until the next battery charging. type: string + chargingEndTime: + type: string + description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end + stopChargeStatus: + type: string + description: | + Status of delayed stop charge. + one of following enums status will be set: + | Enum | Description | + |----------|:-------------:| + | Deactivated | Function is deactivated | + | Activated | The function is activated, and the conditions to execute it are met. | + | Successful | The most recent stop charge was successful. | + | StopChargeFailed | Failed to stop charging. | + | ChargeEndTimeScheduleFailed| The programming of the end of charge failed; the charging should not stop at the requested time. | + + enum: + - Deactivated + - Activated + - Successful + - StopChargeFailed + - ChargeEndTimeScheduleFailed schedule: properties: programs: @@ -4265,11 +4287,39 @@ components: type: string schedule: type: object - description: Charge scheduling. Only one of the two modes, programs or nexDelayedTime, should be provided. + description: | + Charge scheduling: only one of the three modes, ```programs```, ```nextDelayedTime/immediate```, or ```chargingEndTime/chargingEndTimeEnabled```, should be provided. + * ```chargingEndTimeEnabled ```and ```chargingEndTime``` Can be used together to set the end time. + * ```nextDelayedTime``` and ```immediate``` cannot be used together and are mutually exclusive. Mixing them will result in an error (HTTP 400). + Here are the possible combinations of start and end times with their respective settings: immediate start and end time enable toggle. + * ```nextDelayedTime``` and ```immediate``` + | nextDelayedTime | immediate | allowed | + | :------------------: | :-------------------: | :-------------------: | + | set |not set|yes | + | set |set to true/false|no | + | not set |set to true/false |yes | + + * ```chargingEndTime``` and ```chargingEndTimeEnabled``` + | chargingEndTime | chargingEndTimeEnabled | allowed | + | :------------------: | :-------------------: | :-------------------: | + | set |not set|yes | + | set |set to true / false|yes | + | not set |set to true/false |Yes, if the chargingEndTime has been set before; otherwise, it will raise an error (HTTP 400)| + * General rule: An empty schedule object will result in an error (HTTP 400). properties: nextDelayedTime: type: string description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of the next battery charging time. + immediate: + type: boolean + description : Determines if the charging will start immediately(```True```) or not. + example : true + chargingEndTime: + type: string + description: Timestamp (as defined in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)) of when the charging should end + chargingEndTimeEnabled: + type: boolean + description: Enable or disable the programmed charge end time. programs: description: Scheduled charging programs list. type: array