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

   1 {
   2   "$schema": "http://json-schema.org/draft-07/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:GetCompositeScheduleResponse",
   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     "ChargingRateUnitEnumType": {
  19       "description": "The unit of measure Limit is\r\nexpressed in.\r\n",
  20       "javaType": "ChargingRateUnitEnum",
  21       "type": "string",
  22       "additionalProperties": false,
  23       "enum": ["W", "A"]
  24     },
  25     "GenericStatusEnumType": {
  26       "description": "The Charging Station will indicate if it was\r\nable to process the request\r\n",
  27       "javaType": "GenericStatusEnum",
  28       "type": "string",
  29       "additionalProperties": false,
  30       "enum": ["Accepted", "Rejected"]
  31     },
  32     "ChargingSchedulePeriodType": {
  33       "description": "Charging_ Schedule_ Period\r\nurn:x-oca:ocpp:uid:2:233257\r\nCharging schedule period structure defines a time period in a charging schedule.\r\n",
  34       "javaType": "ChargingSchedulePeriod",
  35       "type": "object",
  36       "additionalProperties": false,
  37       "properties": {
  38         "customData": {
  39           "$ref": "#/definitions/CustomDataType"
  40         },
  41         "startPeriod": {
  42           "description": "Charging_ Schedule_ Period. Start_ Period. Elapsed_ Time\r\nurn:x-oca:ocpp:uid:1:569240\r\nStart of the period, in seconds from the start of schedule. The value of StartPeriod also defines the stop time of the previous period.\r\n",
  43           "type": "integer"
  44         },
  45         "limit": {
  46           "description": "Charging_ Schedule_ Period. Limit. Measure\r\nurn:x-oca:ocpp:uid:1:569241\r\nCharging rate limit during the schedule period, in the applicable chargingRateUnit, for example in Amperes (A) or Watts (W). Accepts at most one digit fraction (e.g. 8.1).\r\n",
  47           "type": "number"
  48         },
  49         "numberPhases": {
  50           "description": "Charging_ Schedule_ Period. Number_ Phases. Counter\r\nurn:x-oca:ocpp:uid:1:569242\r\nThe number of phases that can be used for charging. If a number of phases is needed, numberPhases=3 will be assumed unless another number is given.\r\n",
  51           "type": "integer"
  52         },
  53         "phaseToUse": {
  54           "description": "Values: 1..3, Used if numberPhases=1 and if the EVSE is capable of switching the phase connected to the EV, i.e. ACPhaseSwitchingSupported is defined and true. It’s not allowed unless both conditions above are true. If both conditions are true, and phaseToUse is omitted, the Charging Station / EVSE will make the selection on its own.\r\n\r\n",
  55           "type": "integer"
  56         }
  57       },
  58       "required": ["startPeriod", "limit"]
  59     },
  60     "CompositeScheduleType": {
  61       "description": "Composite_ Schedule\r\nurn:x-oca:ocpp:uid:2:233362\r\n",
  62       "javaType": "CompositeSchedule",
  63       "type": "object",
  64       "additionalProperties": false,
  65       "properties": {
  66         "customData": {
  67           "$ref": "#/definitions/CustomDataType"
  68         },
  69         "chargingSchedulePeriod": {
  70           "type": "array",
  71           "additionalItems": false,
  72           "items": {
  73             "$ref": "#/definitions/ChargingSchedulePeriodType"
  74           },
  75           "minItems": 1
  76         },
  77         "evseId": {
  78           "description": "The ID of the EVSE for which the\r\nschedule is requested. When evseid=0, the\r\nCharging Station calculated the expected\r\nconsumption for the grid connection.\r\n",
  79           "type": "integer"
  80         },
  81         "duration": {
  82           "description": "Duration of the schedule in seconds.\r\n",
  83           "type": "integer"
  84         },
  85         "scheduleStart": {
  86           "description": "Composite_ Schedule. Start. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569456\r\nDate and time at which the schedule becomes active. All time measurements within the schedule are relative to this timestamp.\r\n",
  87           "type": "string",
  88           "format": "date-time"
  89         },
  90         "chargingRateUnit": {
  91           "$ref": "#/definitions/ChargingRateUnitEnumType"
  92         }
  93       },
  94       "required": [
  95         "evseId",
  96         "duration",
  97         "scheduleStart",
  98         "chargingRateUnit",
  99         "chargingSchedulePeriod"
 100       ]
 101     },
 102     "StatusInfoType": {
 103       "description": "Element providing more information about the status.\r\n",
 104       "javaType": "StatusInfo",
 105       "type": "object",
 106       "additionalProperties": false,
 107       "properties": {
 108         "customData": {
 109           "$ref": "#/definitions/CustomDataType"
 110         },
 111         "reasonCode": {
 112           "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n",
 113           "type": "string",
 114           "maxLength": 20
 115         },
 116         "additionalInfo": {
 117           "description": "Additional text to provide detailed information.\r\n",
 118           "type": "string",
 119           "maxLength": 512
 120         }
 121       },
 122       "required": ["reasonCode"]
 123     }
 124   },
 125   "type": "object",
 126   "additionalProperties": false,
 127   "properties": {
 128     "customData": {
 129       "$ref": "#/definitions/CustomDataType"
 130     },
 131     "status": {
 132       "$ref": "#/definitions/GenericStatusEnumType"
 133     },
 134     "statusInfo": {
 135       "$ref": "#/definitions/StatusInfoType"
 136     },
 137     "schedule": {
 138       "$ref": "#/definitions/CompositeScheduleType"
 139     }
 140   },
 141   "required": ["status"]
 142 }