@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.
101 lines (100 loc) • 3.67 kB
JSON
{
"$id": "PublishFirmwareStatusNotificationRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"PublishFirmwareStatusEnumType": {
"description": "This contains the progress status of the publishfirmware\r\ninstallation.\r\n",
"javaType": "PublishFirmwareStatusEnum",
"type": "string",
"additionalProperties": false,
"enum": [
"Idle",
"DownloadScheduled",
"Downloading",
"Downloaded",
"Published",
"DownloadFailed",
"DownloadPaused",
"InvalidChecksum",
"ChecksumVerified",
"PublishFailed"
],
"tsEnumNames": [
"Idle",
"DownloadScheduled",
"Downloading",
"Downloaded",
"Published",
"DownloadFailed",
"DownloadPaused",
"InvalidChecksum",
"ChecksumVerified",
"PublishFailed"
]
},
"StatusInfoType": {
"description": "Element providing more information about the status.\r\n",
"javaType": "StatusInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"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": 1024
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["reasonCode"]
},
"CustomDataType": {
"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"$ref": "#/definitions/PublishFirmwareStatusEnumType"
},
"location": {
"description": "Required if status is Published. Can be multiple URI’s, if the Local Controller supports e.g. HTTP, HTTPS, and FTP.\r\n",
"type": "array",
"additionalItems": false,
"items": {
"type": "string",
"maxLength": 2000
},
"minItems": 1
},
"requestId": {
"description": "The request id that was\r\nprovided in the\r\nPublishFirmwareRequest which\r\ntriggered this action.\r\n",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"statusInfo": {
"$ref": "#/definitions/StatusInfoType"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["status"]
}