src/assets/json-schemas/ocpp/2.0/BootNotificationRequest.json

   1 {
   2   "$schema": "http://json-schema.org/draft-06/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:BootNotificationRequest",
   4   "comment": "OCPP 2.0.1 FINAL",
   5   "definitions": {
   6     "CustomDataType": {
   7       "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.",
   8       "javaType": "CustomData",
   9       "type": "object",
  10       "properties": {
  11         "vendorId": {
  12           "type": "string",
  13           "maxLength": 255
  14         }
  15       },
  16       "required": ["vendorId"]
  17     },
  18     "BootReasonEnumType": {
  19       "description": "This contains the reason for sending this message to the CSMS.\r\n",
  20       "javaType": "BootReasonEnum",
  21       "type": "string",
  22       "additionalProperties": false,
  23       "enum": [
  24         "ApplicationReset",
  25         "FirmwareUpdate",
  26         "LocalReset",
  27         "PowerUp",
  28         "RemoteReset",
  29         "ScheduledReset",
  30         "Triggered",
  31         "Unknown",
  32         "Watchdog"
  33       ]
  34     },
  35     "ChargingStationType": {
  36       "description": "Charge_ Point\r\nurn:x-oca:ocpp:uid:2:233122\r\nThe physical system where an Electrical Vehicle (EV) can be charged.\r\n",
  37       "javaType": "ChargingStation",
  38       "type": "object",
  39       "additionalProperties": false,
  40       "properties": {
  41         "customData": {
  42           "$ref": "#/definitions/CustomDataType"
  43         },
  44         "serialNumber": {
  45           "description": "Device. Serial_ Number. Serial_ Number\r\nurn:x-oca:ocpp:uid:1:569324\r\nVendor-specific device identifier.\r\n",
  46           "type": "string",
  47           "maxLength": 25
  48         },
  49         "model": {
  50           "description": "Device. Model. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569325\r\nDefines the model of the device.\r\n",
  51           "type": "string",
  52           "maxLength": 20
  53         },
  54         "modem": {
  55           "$ref": "#/definitions/ModemType"
  56         },
  57         "vendorName": {
  58           "description": "Identifies the vendor (not necessarily in a unique manner).\r\n",
  59           "type": "string",
  60           "maxLength": 50
  61         },
  62         "firmwareVersion": {
  63           "description": "This contains the firmware version of the Charging Station.\r\n\r\n",
  64           "type": "string",
  65           "maxLength": 50
  66         }
  67       },
  68       "required": ["model", "vendorName"]
  69     },
  70     "ModemType": {
  71       "description": "Wireless_ Communication_ Module\r\nurn:x-oca:ocpp:uid:2:233306\r\nDefines parameters required for initiating and maintaining wireless communication with other devices.\r\n",
  72       "javaType": "Modem",
  73       "type": "object",
  74       "additionalProperties": false,
  75       "properties": {
  76         "customData": {
  77           "$ref": "#/definitions/CustomDataType"
  78         },
  79         "iccid": {
  80           "description": "Wireless_ Communication_ Module. ICCID. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569327\r\nThis contains the ICCID of the modem’s SIM card.\r\n",
  81           "type": "string",
  82           "maxLength": 20
  83         },
  84         "imsi": {
  85           "description": "Wireless_ Communication_ Module. IMSI. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569328\r\nThis contains the IMSI of the modem’s SIM card.\r\n",
  86           "type": "string",
  87           "maxLength": 20
  88         }
  89       }
  90     }
  91   },
  92   "type": "object",
  93   "additionalProperties": false,
  94   "properties": {
  95     "customData": {
  96       "$ref": "#/definitions/CustomDataType"
  97     },
  98     "chargingStation": {
  99       "$ref": "#/definitions/ChargingStationType"
 100     },
 101     "reason": {
 102       "$ref": "#/definitions/BootReasonEnumType"
 103     }
 104   },
 105   "required": ["reason", "chargingStation"]
 106 }