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

   1 {
   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",
   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     "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",
  21       "type": "string",
  22       "additionalProperties": false,
  23       "enum": [
  24         "Accepted",
  25         "Blocked",
  26         "ConcurrentTx",
  27         "Expired",
  28         "Invalid",
  29         "NoCredit",
  30         "NotAllowedTypeEVSE",
  31         "NotAtThisLocation",
  32         "NotAtThisTime",
  33         "Unknown"
  34       ]
  35     },
  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",
  39       "type": "string",
  40       "additionalProperties": false,
  41       "enum": [
  42         "Accepted",
  43         "SignatureError",
  44         "CertificateExpired",
  45         "CertificateRevoked",
  46         "NoCertificateAvailable",
  47         "CertChainError",
  48         "ContractCancelled"
  49       ]
  50     },
  51     "IdTokenEnumType": {
  52       "description": "Enumeration of possible idToken types.\r\n",
  53       "javaType": "IdTokenEnum",
  54       "type": "string",
  55       "additionalProperties": false,
  56       "enum": [
  57         "Central",
  58         "eMAID",
  59         "ISO14443",
  60         "ISO15693",
  61         "KeyCode",
  62         "Local",
  63         "MacAddress",
  64         "NoAuthorization"
  65       ]
  66     },
  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",
  70       "type": "string",
  71       "additionalProperties": false,
  72       "enum": ["ASCII", "HTML", "URI", "UTF8"]
  73     },
  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",
  77       "type": "object",
  78       "additionalProperties": false,
  79       "properties": {
  80         "customData": {
  81           "$ref": "#/definitions/CustomDataType"
  82         },
  83         "additionalIdToken": {
  84           "description": "This field specifies the additional IdToken.\r\n",
  85           "type": "string",
  86           "maxLength": 36
  87         },
  88         "type": {
  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",
  90           "type": "string",
  91           "maxLength": 50
  92         }
  93       },
  94       "required": ["additionalIdToken", "type"]
  95     },
  96     "IdTokenInfoType": {
  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",
  99       "type": "object",
 100       "additionalProperties": false,
 101       "properties": {
 102         "customData": {
 103           "$ref": "#/definitions/CustomDataType"
 104         },
 105         "status": {
 106           "$ref": "#/definitions/AuthorizationStatusEnumType"
 107         },
 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",
 110           "type": "string",
 111           "format": "date-time"
 112         },
 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 &lt;&lt;transactioneventresponse,TransactionEventResponse&gt;&gt; overrules this one. \r\n",
 115           "type": "integer"
 116         },
 117         "language1": {
 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 &lt;&lt;ref-RFC5646,[RFC5646]&gt;&gt;.\r\n\r\n",
 119           "type": "string",
 120           "maxLength": 8
 121         },
 122         "evseId": {
 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",
 124           "type": "array",
 125           "additionalItems": false,
 126           "items": {
 127             "type": "integer"
 128           },
 129           "minItems": 1
 130         },
 131         "groupIdToken": {
 132           "$ref": "#/definitions/IdTokenType"
 133         },
 134         "language2": {
 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 &lt;&lt;ref-RFC5646,[RFC5646]&gt;&gt;.\r\n",
 136           "type": "string",
 137           "maxLength": 8
 138         },
 139         "personalMessage": {
 140           "$ref": "#/definitions/MessageContentType"
 141         }
 142       },
 143       "required": ["status"]
 144     },
 145     "IdTokenType": {
 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",
 148       "type": "object",
 149       "additionalProperties": false,
 150       "properties": {
 151         "customData": {
 152           "$ref": "#/definitions/CustomDataType"
 153         },
 154         "additionalInfo": {
 155           "type": "array",
 156           "additionalItems": false,
 157           "items": {
 158             "$ref": "#/definitions/AdditionalInfoType"
 159           },
 160           "minItems": 1
 161         },
 162         "idToken": {
 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",
 164           "type": "string",
 165           "maxLength": 36
 166         },
 167         "type": {
 168           "$ref": "#/definitions/IdTokenEnumType"
 169         }
 170       },
 171       "required": ["idToken", "type"]
 172     },
 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",
 176       "type": "object",
 177       "additionalProperties": false,
 178       "properties": {
 179         "customData": {
 180           "$ref": "#/definitions/CustomDataType"
 181         },
 182         "format": {
 183           "$ref": "#/definitions/MessageFormatEnumType"
 184         },
 185         "language": {
 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 &lt;&lt;ref-RFC5646,[RFC5646]&gt;&gt;.\r\n",
 187           "type": "string",
 188           "maxLength": 8
 189         },
 190         "content": {
 191           "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
 192           "type": "string",
 193           "maxLength": 512
 194         }
 195       },
 196       "required": ["format", "content"]
 197     }
 198   },
 199   "type": "object",
 200   "additionalProperties": false,
 201   "properties": {
 202     "customData": {
 203       "$ref": "#/definitions/CustomDataType"
 204     },
 205     "idTokenInfo": {
 206       "$ref": "#/definitions/IdTokenInfoType"
 207     },
 208     "certificateStatus": {
 209       "$ref": "#/definitions/AuthorizeCertificateStatusEnumType"
 210     }
 211   },
 212   "required": ["idTokenInfo"]
 213 }