2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:TransactionEventResponse",
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,
37 "description": "Enumeration of possible idToken types.\r\n",
38 "javaType": "IdTokenEnum",
40 "additionalProperties": false,
52 "MessageFormatEnumType": {
53 "description": "Message_ Content. Format. Message_ Format_ Code\r\nurn:x-enexis:ecdm:uid:1:570848\r\nFormat of the message.\r\n",
54 "javaType": "MessageFormatEnum",
56 "additionalProperties": false,
57 "enum": ["ASCII", "HTML", "URI", "UTF8"]
59 "AdditionalInfoType": {
60 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
61 "javaType": "AdditionalInfo",
63 "additionalProperties": false,
66 "$ref": "#/definitions/CustomDataType"
68 "additionalIdToken": {
69 "description": "This field specifies the additional IdToken.\r\n",
74 "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",
79 "required": ["additionalIdToken", "type"]
82 "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",
83 "javaType": "IdTokenInfo",
85 "additionalProperties": false,
88 "$ref": "#/definitions/CustomDataType"
91 "$ref": "#/definitions/AuthorizationStatusEnumType"
93 "cacheExpiryDateTime": {
94 "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",
99 "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",
103 "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",
108 "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",
110 "additionalItems": false,
117 "$ref": "#/definitions/IdTokenType"
120 "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",
125 "$ref": "#/definitions/MessageContentType"
128 "required": ["status"]
131 "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
132 "javaType": "IdToken",
134 "additionalProperties": false,
137 "$ref": "#/definitions/CustomDataType"
141 "additionalItems": false,
143 "$ref": "#/definitions/AdditionalInfoType"
148 "description": "IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
153 "$ref": "#/definitions/IdTokenEnumType"
156 "required": ["idToken", "type"]
158 "MessageContentType": {
159 "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",
160 "javaType": "MessageContent",
162 "additionalProperties": false,
165 "$ref": "#/definitions/CustomDataType"
168 "$ref": "#/definitions/MessageFormatEnumType"
171 "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",
176 "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
181 "required": ["format", "content"]
185 "additionalProperties": false,
188 "$ref": "#/definitions/CustomDataType"
191 "description": "SHALL only be sent when charging has ended. Final total cost of this transaction, including taxes. In the currency configured with the Configuration Variable: <<configkey-currency,`Currency`>>. When omitted, the transaction was NOT free. To indicate a free transaction, the CSMS SHALL send 0.00.\r\n\r\n",
194 "chargingPriority": {
195 "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>> is temporarily, so it may not be set in the <<cmn_idtokeninfotype,IdTokenInfoType>> afterwards. Also the chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules the one in <<cmn_idtokeninfotype,IdTokenInfoType>>. \r\n",
199 "$ref": "#/definitions/IdTokenInfoType"
201 "updatedPersonalMessage": {
202 "$ref": "#/definitions/MessageContentType"