e27580f15bb3d7ea5a0dca6e35b1aee6bf8504ca
[e-mobility-charging-stations-simulator.git] / src / assets / json-schemas / ocpp / 2.0 / ReserveNowRequest.json
1 {
2 "$schema": "http://json-schema.org/draft-06/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:ReserveNowRequest",
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 "ConnectorEnumType": {
19 "description": "This field specifies the connector type.\r\n",
20 "javaType": "ConnectorEnum",
21 "type": "string",
22 "additionalProperties": false,
23 "enum": [
24 "cCCS1",
25 "cCCS2",
26 "cG105",
27 "cTesla",
28 "cType1",
29 "cType2",
30 "s309-1P-16A",
31 "s309-1P-32A",
32 "s309-3P-16A",
33 "s309-3P-32A",
34 "sBS1361",
35 "sCEE-7-7",
36 "sType2",
37 "sType3",
38 "Other1PhMax16A",
39 "Other1PhOver16A",
40 "Other3Ph",
41 "Pan",
42 "wInductive",
43 "wResonant",
44 "Undetermined",
45 "Unknown"
46 ]
47 },
48 "IdTokenEnumType": {
49 "description": "Enumeration of possible idToken types.\r\n",
50 "javaType": "IdTokenEnum",
51 "type": "string",
52 "additionalProperties": false,
53 "enum": [
54 "Central",
55 "eMAID",
56 "ISO14443",
57 "ISO15693",
58 "KeyCode",
59 "Local",
60 "MacAddress",
61 "NoAuthorization"
62 ]
63 },
64 "AdditionalInfoType": {
65 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
66 "javaType": "AdditionalInfo",
67 "type": "object",
68 "additionalProperties": false,
69 "properties": {
70 "customData": {
71 "$ref": "#/definitions/CustomDataType"
72 },
73 "additionalIdToken": {
74 "description": "This field specifies the additional IdToken.\r\n",
75 "type": "string",
76 "maxLength": 36
77 },
78 "type": {
79 "description": "This defines the type of the additionalIdToken. This is a custom type, so the implementation needs to be agreed upon by all involved parties.\r\n",
80 "type": "string",
81 "maxLength": 50
82 }
83 },
84 "required": ["additionalIdToken", "type"]
85 },
86 "IdTokenType": {
87 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
88 "javaType": "IdToken",
89 "type": "object",
90 "additionalProperties": false,
91 "properties": {
92 "customData": {
93 "$ref": "#/definitions/CustomDataType"
94 },
95 "additionalInfo": {
96 "type": "array",
97 "additionalItems": false,
98 "items": {
99 "$ref": "#/definitions/AdditionalInfoType"
100 },
101 "minItems": 1
102 },
103 "idToken": {
104 "description": "IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
105 "type": "string",
106 "maxLength": 36
107 },
108 "type": {
109 "$ref": "#/definitions/IdTokenEnumType"
110 }
111 },
112 "required": ["idToken", "type"]
113 }
114 },
115 "type": "object",
116 "additionalProperties": false,
117 "properties": {
118 "customData": {
119 "$ref": "#/definitions/CustomDataType"
120 },
121 "id": {
122 "description": "Id of reservation.\r\n",
123 "type": "integer"
124 },
125 "expiryDateTime": {
126 "description": "Date and time at which the reservation expires.\r\n",
127 "type": "string",
128 "format": "date-time"
129 },
130 "connectorType": {
131 "$ref": "#/definitions/ConnectorEnumType"
132 },
133 "idToken": {
134 "$ref": "#/definitions/IdTokenType"
135 },
136 "evseId": {
137 "description": "This contains ID of the evse to be reserved.\r\n",
138 "type": "integer"
139 },
140 "groupIdToken": {
141 "$ref": "#/definitions/IdTokenType"
142 }
143 },
144 "required": ["id", "expiryDateTime", "idToken"]
145 }