OCPP 2.0.1 Schemas — Provisioning

Functional Block: B

Types Reference: Shared types referenced below are defined in OCPP-2.0.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

• BootNotification (CS → CSMS)
• Heartbeat (CS → CSMS)
• StatusNotification (CS → CSMS)
• GetVariables (CSMS → CS)
• SetVariables (CSMS → CS)
• GetBaseReport (CSMS → CS)
• GetReport (CSMS → CS)
• NotifyReport (CS → CSMS)
• Reset (CSMS → CS)
• DataTransfer (Both)
• SetNetworkProfile (CSMS → CS)

#BootNotification

Direction: CS → CSMS

#BootNotificationRequest

{
  "chargingStation": {
    "model": "string",
    "vendorName": "string"
  },
  "reason": "ApplicationReset"
}

#BootNotificationResponse

#Heartbeat

Direction: CS → CSMS

#HeartbeatRequest

#HeartbeatResponse

#StatusNotification

Direction: CS → CSMS

#StatusNotificationRequest

{
  "connectorId": 0,
  "connectorStatus": "Available",
  "evseId": 0,
  "timestamp": "2024-01-15T10:30:00Z"
}

#StatusNotificationResponse

No required fields. An empty {} is a valid response.

#GetVariables

Direction: CSMS → CS

#GetVariablesRequest

{
  "getVariableData": [
    {
      "component": "{...}",
      "variable": "{...}"
    }
  ]
}

#GetVariablesResponse

#SetVariables

Direction: CSMS → CS

#SetVariablesRequest

{
  "setVariableData": [
    {
      "attributeValue": "string",
      "component": "{...}",
      "variable": "{...}"
    }
  ]
}

#SetVariablesResponse

#GetBaseReport

Direction: CSMS → CS

#GetBaseReportRequest

{
  "reportBase": "ConfigurationInventory",
  "requestId": 0
}

#GetBaseReportResponse

#GetReport

Direction: CSMS → CS

#GetReportRequest

{
  "requestId": 0
}

#GetReportResponse

#NotifyReport

Direction: CS → CSMS

#NotifyReportRequest

{
  "generatedAt": "2024-01-15T10:30:00Z",
  "requestId": 0,
  "seqNo": 0
}

#NotifyReportResponse

No required fields. An empty {} is a valid response.

#Reset

Direction: CSMS → CS

#ResetRequest

{
  "type": "Immediate"
}

#ResetResponse

#DataTransfer

Direction: Both

#DataTransferRequest

{
  "vendorId": "string"
}

#DataTransferResponse

#SetNetworkProfile

Direction: CSMS → CS

#SetNetworkProfileRequest

{
  "configurationSlot": 0,
  "connectionData": {
    "ocppVersion": "OCPP12",
    "ocppTransport": "JSON",
    "ocppCsmsUrl": "string",
    "messageTimeout": 0,
    "securityProfile": 0,
    "ocppInterface": "Wired0"
  }
}

#SetNetworkProfileResponse

#Local Types

Types used only within this block's messages.

#APNAuthenticationEnumType

Authentication method.

Used in: SetNetworkProfile

#BootReasonEnumType

This contains the reason for sending this message to the CSMS.

Used in: BootNotification

#ComponentCriterionEnumType

Used in: GetReport

#ConnectorStatusEnumType

This contains the current status of the Connector.

Used in: StatusNotification

#DataEnumType

Data type of this variable.

Used in: NotifyReport

#DataTransferStatusEnumType

This indicates the success or failure of the data transfer.

Used in: DataTransfer

#GetVariableStatusEnumType

Result status of getting the variable.

Used in: GetVariables

#MutabilityEnumType

Defines the mutability of this attribute. Default is ReadWrite when omitted.

Default: ReadWrite

Used in: NotifyReport

#OCPPInterfaceEnumType

Applicable Network Interface.

Used in: SetNetworkProfile

#OCPPTransportEnumType

Defines the transport protocol (e.g. SOAP or JSON). Note: SOAP is not supported in OCPP 2.0, but is supported by other versions of OCPP.

Used in: SetNetworkProfile

#OCPPVersionEnumType

Defines the OCPP version used for this communication function.

Used in: SetNetworkProfile

#RegistrationStatusEnumType

This contains whether the Charging Station has been registered within the CSMS.

Used in: BootNotification

#ReportBaseEnumType

This field specifies the report base.

Used in: GetBaseReport

#ResetEnumType

This contains the type of reset that the Charging Station or EVSE should perform.

Used in: Reset

#ResetStatusEnumType

This indicates whether the Charging Station is able to perform the reset.

Used in: Reset

#SetNetworkProfileStatusEnumType

Result of operation.

Used in: SetNetworkProfile

#SetVariableStatusEnumType

Result status of setting the variable.

Used in: SetVariables

#VPNEnumType

Type of VPN

Used in: SetNetworkProfile

#APNType

Collection of configuration data needed to make a data-connection over a cellular network. NOTE: When asking a GSM modem to dial in, it is possible to specify which mobile operator should be used. This can be done with the mobile country code (MCC) in combination with a mobile network code (MNC). Example: If your preferred network is Vodafone Netherlands, the MCC=204 and the MNC=04 which means the key PreferredNetwork = 20404 Some modems allows to specify a preferred network, which means, if this network is not available, a different network is used. If you specify UseOnlyPreferredNetwork and this network is not available, the modem will not dial in.

Used in: SetNetworkProfile

#ChargingStationType

The physical system where an Electrical Vehicle (EV) can be charged.

Used in: BootNotification

#ComponentVariableType

Class to report components, variables and variable attributes and characteristics.

Used in: GetMonitoringReport, GetReport

#GetVariableDataType

Class to hold parameters for GetVariables request.

Used in: GetVariables

#GetVariableResultType

Class to hold results of GetVariables request.

Used in: GetVariables

#ModemType

Defines parameters required for initiating and maintaining wireless communication with other devices.

Used in: BootNotification

#NetworkConnectionProfileType

The NetworkConnectionProfile defines the functional and technical parameters of a communication link.

Used in: SetNetworkProfile

#ReportDataType

Class to report components, variables and variable attributes and characteristics.

Used in: NotifyReport

#SetVariableDataType

Used in: SetVariables

#SetVariableResultType

Used in: SetVariables

#VPNType

VPN Configuration settings

Used in: SetNetworkProfile

#VariableAttributeType

Attribute data of a variable.

Used in: NotifyReport

#VariableCharacteristicsType

Fixed read-only parameters of a variable.

Used in: NotifyReport