@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
141 lines (140 loc) • 6.6 kB
JSON
{
"$id": "CustomerInformationRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"HashAlgorithmEnumType": {
"description": "Used algorithms for the hashes provided.\r\n",
"javaType": "HashAlgorithmEnum",
"type": "string",
"additionalProperties": false,
"enum": ["SHA256", "SHA384", "SHA512"],
"tsEnumNames": ["SHA256", "SHA384", "SHA512"]
},
"AdditionalInfoType": {
"description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
"javaType": "AdditionalInfo",
"type": "object",
"additionalProperties": false,
"properties": {
"additionalIdToken": {
"description": "*(2.1)* This field specifies the additional IdToken.\r\n",
"type": "string",
"maxLength": 255
},
"type": {
"description": "_additionalInfo_ can be used to send extra information to CSMS in addition to the regular authorization with _IdToken_. _AdditionalInfo_ contains one or more custom _types_, which need to be agreed upon by all parties involved. When the _type_ is not supported, the CSMS/Charging Station MAY ignore the _additionalInfo_.\r\n\r\n",
"type": "string",
"maxLength": 50
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["additionalIdToken", "type"]
},
"CertificateHashDataType": {
"javaType": "CertificateHashData",
"type": "object",
"additionalProperties": false,
"properties": {
"hashAlgorithm": {
"$ref": "#/definitions/HashAlgorithmEnumType"
},
"issuerNameHash": {
"description": "The hash of the issuer’s distinguished\r\nname (DN), that must be calculated over the DER\r\nencoding of the issuer’s name field in the certificate\r\nbeing checked.\r\n\r\n",
"type": "string",
"maxLength": 128
},
"issuerKeyHash": {
"description": "The hash of the DER encoded public key:\r\nthe value (excluding tag and length) of the subject\r\npublic key field in the issuer’s certificate.\r\n",
"type": "string",
"maxLength": 128
},
"serialNumber": {
"description": "The string representation of the\r\nhexadecimal value of the serial number without the\r\nprefix \"0x\" and without leading zeroes.\r\n",
"type": "string",
"maxLength": 40
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["hashAlgorithm", "issuerNameHash", "issuerKeyHash", "serialNumber"]
},
"IdTokenType": {
"description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
"javaType": "IdToken",
"type": "object",
"additionalProperties": false,
"properties": {
"additionalInfo": {
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/definitions/AdditionalInfoType"
},
"minItems": 1
},
"idToken": {
"description": "*(2.1)* IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
"type": "string",
"maxLength": 255
},
"type": {
"description": "*(2.1)* Enumeration of possible idToken types. Values defined in Appendix as IdTokenEnumStringType.\r\n",
"type": "string",
"maxLength": 20
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["idToken", "type"]
},
"CustomDataType": {
"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.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"customerCertificate": {
"$ref": "#/definitions/CertificateHashDataType"
},
"idToken": {
"$ref": "#/definitions/IdTokenType"
},
"requestId": {
"description": "The Id of the request.\r\n\r\n",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"report": {
"description": "Flag indicating whether the Charging Station should return NotifyCustomerInformationRequest messages containing information about the customer referred to.\r\n",
"type": "boolean"
},
"clear": {
"description": "Flag indicating whether the Charging Station should clear all information about the customer referred to.\r\n",
"type": "boolean"
},
"customerIdentifier": {
"description": "A (e.g. vendor specific) identifier of the customer this request refers to. This field contains a custom identifier other than IdToken and Certificate.\r\nOne of the possible identifiers (customerIdentifier, customerIdToken or customerCertificate) should be in the request message.\r\n",
"type": "string",
"maxLength": 64
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["requestId", "report", "clear"]
}