Commit | Line | Data |
---|---|---|
d270cc87 | 1 | { |
98fc1389 | 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
d270cc87 | 3 | "$id": "urn:OCPP:Cp:2:2020:3:BootNotificationResponse", |
98fc1389 | 4 | "$comment": "OCPP 2.0.1 FINAL", |
d270cc87 JB |
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 | "RegistrationStatusEnumType": { | |
19 | "description": "This contains whether the Charging Station has been registered\r\nwithin the CSMS.\r\n", | |
20 | "javaType": "RegistrationStatusEnum", | |
21 | "type": "string", | |
22 | "additionalProperties": false, | |
23 | "enum": ["Accepted", "Pending", "Rejected"] | |
24 | }, | |
25 | "StatusInfoType": { | |
26 | "description": "Element providing more information about the status.\r\n", | |
27 | "javaType": "StatusInfo", | |
28 | "type": "object", | |
29 | "additionalProperties": false, | |
30 | "properties": { | |
31 | "customData": { | |
32 | "$ref": "#/definitions/CustomDataType" | |
33 | }, | |
34 | "reasonCode": { | |
35 | "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n", | |
36 | "type": "string", | |
37 | "maxLength": 20 | |
38 | }, | |
39 | "additionalInfo": { | |
40 | "description": "Additional text to provide detailed information.\r\n", | |
41 | "type": "string", | |
42 | "maxLength": 512 | |
43 | } | |
44 | }, | |
45 | "required": ["reasonCode"] | |
46 | } | |
47 | }, | |
48 | "type": "object", | |
49 | "additionalProperties": false, | |
50 | "properties": { | |
51 | "customData": { | |
52 | "$ref": "#/definitions/CustomDataType" | |
53 | }, | |
54 | "currentTime": { | |
55 | "description": "This contains the CSMS’s current time.\r\n", | |
56 | "type": "string", | |
57 | "format": "date-time" | |
58 | }, | |
59 | "interval": { | |
60 | "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", | |
61 | "type": "integer" | |
62 | }, | |
63 | "status": { | |
64 | "$ref": "#/definitions/RegistrationStatusEnumType" | |
65 | }, | |
66 | "statusInfo": { | |
67 | "$ref": "#/definitions/StatusInfoType" | |
68 | } | |
69 | }, | |
70 | "required": ["currentTime", "interval", "status"] | |
71 | } |