2 "$schema": "http://json-schema.org/draft-06/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:AuthorizeResponse",
4 "comment": "OCPP 2.0.1 FINAL",
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",
16 "required": ["vendorId"]
18 "AuthorizationStatusEnumType": {
19 "description": "ID_ Token. Status. Authorization_ Status\r\nurn:x-oca:ocpp:uid:1:569372\r\nCurrent status of the ID Token.\r\n",
20 "javaType": "AuthorizationStatusEnum",
22 "additionalProperties": false,
36 "AuthorizeCertificateStatusEnumType": {
37 "description": "Certificate status information. \r\n- if all certificates are valid: return 'Accepted'.\r\n- if one of the certificates was revoked, return 'CertificateRevoked'.\r\n",
38 "javaType": "AuthorizeCertificateStatusEnum",
40 "additionalProperties": false,
46 "NoCertificateAvailable",
52 "description": "Enumeration of possible idToken types.\r\n",
53 "javaType": "IdTokenEnum",
55 "additionalProperties": false,
67 "MessageFormatEnumType": {
68 "description": "Message_ Content. Format. Message_ Format_ Code\r\nurn:x-enexis:ecdm:uid:1:570848\r\nFormat of the message.\r\n",
69 "javaType": "MessageFormatEnum",
71 "additionalProperties": false,
72 "enum": ["ASCII", "HTML", "URI", "UTF8"]
74 "AdditionalInfoType": {
75 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
76 "javaType": "AdditionalInfo",
78 "additionalProperties": false,
81 "$ref": "#/definitions/CustomDataType"
83 "additionalIdToken": {
84 "description": "This field specifies the additional IdToken.\r\n",
89 "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",
94 "required": ["additionalIdToken", "type"]
97 "description": "ID_ Token\r\nurn:x-oca:ocpp:uid:2:233247\r\nContains status information about an identifier.\r\nIt is advised to not stop charging for a token that expires during charging, as ExpiryDate is only used for caching purposes. If ExpiryDate is not given, the status has no end date.\r\n",
98 "javaType": "IdTokenInfo",
100 "additionalProperties": false,
103 "$ref": "#/definitions/CustomDataType"
106 "$ref": "#/definitions/AuthorizationStatusEnumType"
108 "cacheExpiryDateTime": {
109 "description": "ID_ Token. Expiry. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569373\r\nDate and Time after which the token must be considered invalid.\r\n",
111 "format": "date-time"
113 "chargingPriority": {
114 "description": "Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules this one. \r\n",
118 "description": "ID_ Token. Language1. Language_ Code\r\nurn:x-oca:ocpp:uid:1:569374\r\nPreferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n\r\n",
123 "description": "Only used when the IdToken is only valid for one or more specific EVSEs, not for the entire Charging Station.\r\n\r\n",
125 "additionalItems": false,
132 "$ref": "#/definitions/IdTokenType"
135 "description": "ID_ Token. Language2. Language_ Code\r\nurn:x-oca:ocpp:uid:1:569375\r\nSecond preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n",
140 "$ref": "#/definitions/MessageContentType"
143 "required": ["status"]
146 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
147 "javaType": "IdToken",
149 "additionalProperties": false,
152 "$ref": "#/definitions/CustomDataType"
156 "additionalItems": false,
158 "$ref": "#/definitions/AdditionalInfoType"
163 "description": "IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
168 "$ref": "#/definitions/IdTokenEnumType"
171 "required": ["idToken", "type"]
173 "MessageContentType": {
174 "description": "Message_ Content\r\nurn:x-enexis:ecdm:uid:2:234490\r\nContains message details, for a message to be displayed on a Charging Station.\r\n\r\n",
175 "javaType": "MessageContent",
177 "additionalProperties": false,
180 "$ref": "#/definitions/CustomDataType"
183 "$ref": "#/definitions/MessageFormatEnumType"
186 "description": "Message_ Content. Language. Language_ Code\r\nurn:x-enexis:ecdm:uid:1:570849\r\nMessage language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n",
191 "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
196 "required": ["format", "content"]
200 "additionalProperties": false,
203 "$ref": "#/definitions/CustomDataType"
206 "$ref": "#/definitions/IdTokenInfoType"
208 "certificateStatus": {
209 "$ref": "#/definitions/AuthorizeCertificateStatusEnumType"
212 "required": ["idTokenInfo"]