@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
74 lines (73 loc) • 2.88 kB
JSON
{
"$id": "BootNotificationResponse",
"comment": "OCPP 2.0.1 FINAL",
"definitions": {
"CustomDataType": {
"description": "Represents OCPP CustomData. Allows vendor-specific extension properties.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
},
"RegistrationStatusEnumType": {
"description": "This contains whether the Charging Station has been registered\r\nwithin the CSMS.\r\n",
"javaType": "RegistrationStatusEnum",
"type": "string",
"additionalProperties": true,
"enum": ["Accepted", "Pending", "Rejected"],
"tsEnumNames": ["Accepted", "Pending", "Rejected"]
},
"StatusInfoType": {
"description": "Element providing more information about the status.\r\n",
"javaType": "StatusInfo",
"type": "object",
"additionalProperties": true,
"properties": {
"customData": {
"$ref": "#/definitions/CustomDataType"
},
"reasonCode": {
"description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n",
"type": "string",
"maxLength": 20
},
"additionalInfo": {
"description": "Additional text to provide detailed information.\r\n",
"type": "string",
"maxLength": 512
}
},
"required": ["reasonCode"]
}
},
"type": "object",
"additionalProperties": true,
"properties": {
"customData": {
"$ref": "#/definitions/CustomDataType"
},
"currentTime": {
"description": "This contains the CSMS’s current time.\r\n",
"type": "string",
"format": "date-time"
},
"interval": {
"description": "When <<cmn_registrationstatusenumtype,Status>> is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.\r\n",
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"status": {
"$ref": "#/definitions/RegistrationStatusEnumType"
},
"statusInfo": {
"$ref": "#/definitions/StatusInfoType"
}
},
"required": ["currentTime", "interval", "status"]
}