OCPP Message Catalog
Auto-generated documentation for OCPP 2.1 messages.
Total Messages: 209
Messages
AbsolutePriceScheduleType
Request
No properties
Response
No properties
ACChargingParametersType
Request
No properties
Response
No properties
AdditionalInfoType
Request
No properties
Response
No properties
AdditionalSelectedServicesType
Request
No properties
Response
No properties
AddressType
Request
No properties
Response
No properties
AdjustPeriodicEventStream
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int | Required | ||
| params | PeriodicEventStreamParamsType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
AFRRSignal
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| timestamp | DateTime | Required | Time when signal becomes active. | |
| signal | int | Required | Value of signal in v2xSignalWattCurve. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
APNType
Request
No properties
Response
No properties
AuthorizationData
Request
No properties
Response
No properties
Authorize
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| idToken | IdTokenType | Required | ||
| certificate | string | Optional | max: 10000 | (2.1) The X.509 certificate chain presented by EV and encoded in PEM format. Order of certificates in chain is from leaf up to (but excluding) root certificate. + Only needed in case of central contract validation when Charging Station cannot validate the contract certificate. |
| iso15118CertificateHashData | OCSPRequestDataType[] | Optional | min items: 1, max items: 4 |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| idTokenInfo | IdTokenInfoType | Required | ||
| certificateStatus | AuthorizeCertificateStatusEnumType | Optional | ||
| allowedEnergyTransfer | EnergyTransferModeEnumType[] | Optional | min items: 1 | (2.1) List of allowed energy transfer modes the EV can choose from. If omitted this defaults to charging only. |
| tariff | TariffType | Optional |
BatteryDataType
Request
No properties
Response
No properties
BatterySwap
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| batteryData | BatteryDataType[] | Required | min items: 1 | |
| eventType | BatterySwapEventEnumType | Required | ||
| idToken | IdTokenType | Required | ||
| requestId | int | Required | RequestId to correlate BatteryIn/Out events and optional RequestBatterySwapRequest. |
Response
No properties
BootNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingStation | ChargingStationType | Required | ||
| reason | BootReasonEnumType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| currentTime | DateTime | Required | This contains the CSMS’s current time. | |
| interval | int | Required | When <<cmn_registrationstatusenumtype,Status>> is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request. | |
| status | RegistrationStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
CancelReservation
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| reservationId | int | Required | Id of the reservation to cancel. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | CancelReservationStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
CertificateHashDataChainType
Request
No properties
Response
No properties
CertificateHashDataType
Request
No properties
Response
No properties
CertificateSigned
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateChain | string | Required | max: 10000 | The signed PEM encoded X.509 certificate. This SHALL also contain the necessary sub CA certificates, when applicable. The order of the bundle follows the certificate chain, starting from the leaf certificate. The Configuration Variable <<configkey-max-certificate-chain-size,MaxCertificateChainSize>> can be used to limit the maximum size of this field. |
| certificateType | CertificateSigningUseEnumType | Optional | ||
| requestId | int | Optional | (2.1) RequestId to correlate this message with the SignCertificateRequest. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | CertificateSignedStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
CertificateStatusInfoType
Request
No properties
Response
No properties
CertificateStatusType
Request
No properties
Response
No properties
ChangeAvailability
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evse | EVSEType | Optional | ||
| operationalStatus | OperationalStatusEnumType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ChangeAvailabilityStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ChangeTransactionTariff
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| tariff | TariffType | Required | ||
| transactionId | string | Required | max: 36 | Transaction id for new tariff. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | TariffChangeStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ChargingLimitType
Request
No properties
Response
No properties
ChargingNeedsType
Request
No properties
Response
No properties
ChargingPeriodType
Request
No properties
Response
No properties
ChargingProfileCriterionType
Request
No properties
Response
No properties
ChargingProfileType
Request
No properties
Response
No properties
ChargingSchedulePeriodType
Request
No properties
Response
No properties
ChargingScheduleType
Request
No properties
Response
No properties
ChargingScheduleUpdateType
Request
No properties
Response
No properties
ChargingStationType
Request
No properties
Response
No properties
ClearCache
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
No properties
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ClearCacheStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ClearChargingProfile
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingProfileId | int | Optional | The Id of the charging profile to clear. | |
| chargingProfileCriteria | ClearChargingProfileType | Optional |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ClearChargingProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ClearChargingProfileType
Request
No properties
Response
No properties
ClearDERControl
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| isDefault | bool | Required | True: clearing default DER controls. False: clearing scheduled controls. | |
| controlType | DERControlEnumType | Optional | ||
| controlId | string | Optional | max: 36 | Id of control setting to clear. When omitted all settings for controlType are cleared. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DERControlStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ClearDisplayMessage
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int | Required | Id of the message that SHALL be removed from the Charging Station. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ClearMessageStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
ClearedChargingLimit
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingLimitSource | string | Required | max: 20 | Source of the charging limit. Allowed values defined in Appendix as ChargingLimitSourceEnumStringType. |
| evseId | int | Optional | EVSE Identifier. |
Response
No properties
ClearMonitoringResultType
Request
No properties
Response
No properties
ClearTariffs
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| tariffIds | string[] | Optional | min items: 1 | List of tariff Ids to clear. When absent clears all tariffs at evseId. |
| evseId | int | Optional | When present only clear tariffs matching tariffIds at EVSE evseId. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| clearTariffsResult | ClearTariffsResultType[] | Required | min items: 1 |
ClearTariffsResultType
Request
No properties
Response
No properties
ClearVariableMonitoring
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int[] | Required | min items: 1 | List of the monitors to be cleared, identified by there Id. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| clearMonitoringResult | ClearMonitoringResultType[] | Required | min items: 1 |
ClosePeriodicEventStream
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int | Required | Id of stream to close. |
Response
No properties
ComponentType
Request
No properties
Response
No properties
ComponentVariableType
Request
No properties
Response
No properties
CompositeScheduleType
Request
No properties
Response
No properties
ConstantStreamDataType
Request
No properties
Response
No properties
ConsumptionCostType
Request
No properties
Response
No properties
CostDetailsType
Request
No properties
Response
No properties
CostDimensionType
Request
No properties
Response
No properties
CostType
Request
No properties
Response
No properties
CostUpdated
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| totalCost | decimal | Required | Current total cost, based on the information known by the CSMS, of the transaction including taxes. In the currency configured with the configuration Variable: [<<configkey-currency, Currency>>] | |
| transactionId | string | Required | max: 36 | Transaction Id of the transaction the current cost are asked for. |
Response
No properties
CustomDataType
Request
No properties
Response
No properties
CustomerInformation
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| customerCertificate | CertificateHashDataType | Optional | ||
| idToken | IdTokenType | Optional | ||
| requestId | int | Required | The Id of the request. | |
| report | bool | Required | Flag indicating whether the Charging Station should return NotifyCustomerInformationRequest messages containing information about the customer referred to. | |
| clear | bool | Required | Flag indicating whether the Charging Station should clear all information about the customer referred to. | |
| customerIdentifier | string | Optional | max: 64 | A (e.g. vendor specific) identifier of the customer this request refers to. This field contains a custom identifier other than IdToken and Certificate. One of the possible identifiers (customerIdentifier, customerIdToken or customerCertificate) should be in the request message. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | CustomerInformationStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
DataTransfer
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| messageId | string | Optional | max: 50 | May be used to indicate a specific message or implementation. |
| data | object | Optional | Data without specified length or format. This needs to be decided by both parties (Open to implementation). | |
| vendorId | string | Required | max: 255 | This identifies the Vendor specific implementation |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DataTransferStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| data | object | Optional | Data without specified length or format, in response to request. |
DCChargingParametersType
Request
No properties
Response
No properties
DeleteCertificate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateHashData | CertificateHashDataType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DeleteCertificateStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
DERChargingParametersType
Request
No properties
Response
No properties
DERCurveGetType
Request
No properties
Response
No properties
DERCurvePointsType
Request
No properties
Response
No properties
DERCurveType
Request
No properties
Response
No properties
EnterServiceGetType
Request
No properties
Response
No properties
EnterServiceType
Request
No properties
Response
No properties
EVAbsolutePriceScheduleEntryType
Request
No properties
Response
No properties
EVAbsolutePriceScheduleType
Request
No properties
Response
No properties
EVEnergyOfferType
Request
No properties
Response
No properties
EventDataType
Request
No properties
Response
No properties
EVPowerScheduleEntryType
Request
No properties
Response
No properties
EVPowerScheduleType
Request
No properties
Response
No properties
EVPriceRuleType
Request
No properties
Response
No properties
EVSEType
Request
No properties
Response
No properties
FirmwareStatusNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | FirmwareStatusEnumType | Required | ||
| requestId | int | Optional | The request id that was provided in the UpdateFirmwareRequest that started this firmware update. This field is mandatory, unless the message was triggered by a TriggerMessageRequest AND there is no firmware update ongoing. | |
| statusInfo | StatusInfoType | Optional |
Response
No properties
FirmwareType
Request
No properties
Response
No properties
FixedPFGetType
Request
No properties
Response
No properties
FixedPFType
Request
No properties
Response
No properties
FixedVarGetType
Request
No properties
Response
No properties
FixedVarType
Request
No properties
Response
No properties
FreqDroopGetType
Request
No properties
Response
No properties
FreqDroopType
Request
No properties
Response
No properties
Get15118EVCertificate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| iso15118SchemaVersion | string | Required | max: 50 | Schema version currently used for the 15118 session between EV and Charging Station. Needed for parsing of the EXI stream by the CSMS. |
| action | CertificateActionEnumType | Required | ||
| exiRequest | string | Required | max: 11000 | (2.1) Raw CertificateInstallationReq request from EV, Base64 encoded. + Extended to support ISO 15118-20 certificates. The minimum supported length is 11000. If a longer exiRequest is supported, then the supported length must be communicated in variable OCPPCommCtrlr.FieldLength[ "Get15118EVCertificateRequest.exiRequest" ]. |
| maximumContractCertificateChains | int | Optional | (2.1) Absent during ISO 15118-2 session. Required during ISO 15118-20 session. + Maximum number of contracts that EV wants to install. | |
| prioritizedEMAIDs | string[] | Optional | min items: 1, max items: 8 | (2.1) Absent during ISO 15118-2 session. Optional during ISO 15118-20 session. List of EMAIDs for which contract certificates must be requested first, in case there are more certificates than allowed by maximumContractCertificateChains. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | Iso15118EVCertificateStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| exiResponse | string | Required | max: 17000 | (2/1) Raw CertificateInstallationRes response for the EV, Base64 encoded. + Extended to support ISO 15118-20 certificates. The minimum supported length is 17000. If a longer exiResponse is supported, then the supported length must be communicated in variable OCPPCommCtrlr.FieldLength[ "Get15118EVCertificateResponse.exiResponse" ]. |
| remainingContracts | int | Optional | (2.1) Number of contracts that can be retrieved with additional requests. |
GetBaseReport
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| requestId | int | Required | The Id of the request. | |
| reportBase | ReportBaseEnumType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericDeviceModelStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetCertificateChainStatus
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateStatusRequests | CertificateStatusRequestInfoType[] | Required | min items: 1, max items: 4 |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateStatus | CertificateStatusType[] | Required | min items: 1, max items: 4 |
GetCertificateStatus
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| ocspRequestData | OCSPRequestDataType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GetCertificateStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| ocspResult | string | Optional | max: 18000 | (2.1) OCSPResponse class as defined in <<ref-ocpp_security_24, IETF RFC 6960>>. DER encoded (as defined in <<ref-ocpp_security_24, IETF RFC 6960>>), and then base64 encoded. MAY only be omitted when status is not Accepted. + The minimum supported length is 18000. If a longer ocspResult is supported, then the supported length must be communicated in variable OCPPCommCtrlr.FieldLength[ "GetCertificateStatusResponse.ocspResult" ]. |
GetChargingProfiles
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| requestId | int | Required | Reference identification that is to be used by the Charging Station in the <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> when provided. | |
| evseId | int | Optional | For which EVSE installed charging profiles SHALL be reported. If 0, only charging profiles installed on the Charging Station itself (the grid connection) SHALL be reported. If omitted, all installed charging profiles SHALL be reported. + Reported charging profiles SHALL match the criteria in field chargingProfile. | |
| chargingProfile | ChargingProfileCriterionType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GetChargingProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetCompositeSchedule
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| duration | int | Required | Length of the requested schedule in seconds. | |
| chargingRateUnit | ChargingRateUnitEnumType | Optional | ||
| evseId | int | Required | The ID of the EVSE for which the schedule is requested. When evseid=0, the Charging Station will calculate the expected consumption for the grid connection. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| schedule | CompositeScheduleType | Optional |
GetDERControl
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| requestId | int | Required | RequestId to be used in ReportDERControlRequest. | |
| isDefault | bool | Optional | True: get a default DER control. False: get a scheduled control. | |
| controlType | DERControlEnumType | Optional | ||
| controlId | string | Optional | max: 36 | Id of setting to get. When omitted all settings for controlType are retrieved. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DERControlStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetDisplayMessages
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int[] | Optional | min items: 1 | If provided the Charging Station shall return Display Messages of the given ids. This field SHALL NOT contain more ids than set in <<configkey-number-of-display-messages,NumberOfDisplayMessages.maxLimit>> |
| requestId | int | Required | The Id of this request. | |
| priority | MessagePriorityEnumType | Optional | ||
| state | MessageStateEnumType | Optional |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GetDisplayMessagesStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetInstalledCertificateIds
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateType | GetCertificateIdUseEnumType[] | Optional | min items: 1 | Indicates the type of certificates requested. When omitted, all certificate types are requested. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GetInstalledCertificateStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| certificateHashDataChain | CertificateHashDataChainType[] | Optional | min items: 1 |
GetLocalListVersion
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
No properties
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| versionNumber | int | Required | This contains the current version number of the local authorization list in the Charging Station. |
GetLog
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| log | LogParametersType | Required | ||
| logType | LogEnumType | Required | ||
| requestId | int | Required | The Id of this request | |
| retries | int | Optional | This specifies how many times the Charging Station must retry to upload the log before giving up. If this field is not present, it is left to Charging Station to decide how many times it wants to retry. If the value is 0, it means: no retries. | |
| retryInterval | int | Optional | The interval in seconds after which a retry may be attempted. If this field is not present, it is left to Charging Station to decide how long to wait between attempts. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | LogStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| filename | string | Optional | max: 255 | This contains the name of the log file that will be uploaded. This field is not present when no logging information is available. |
GetMonitoringReport
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| componentVariable | ComponentVariableType[] | Optional | min items: 1 | |
| requestId | int | Required | The Id of the request. | |
| monitoringCriteria | MonitoringCriterionEnumType[] | Optional | min items: 1, max items: 3 | This field contains criteria for components for which a monitoring report is requested |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericDeviceModelStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetPeriodicEventStream
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
No properties
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| constantStreamData | ConstantStreamDataType[] | Optional | min items: 1 |
GetReport
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| componentVariable | ComponentVariableType[] | Optional | min items: 1 | |
| requestId | int | Required | The Id of the request. | |
| componentCriteria | ComponentCriterionEnumType[] | Optional | min items: 1, max items: 4 | This field contains criteria for components for which a report is requested |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericDeviceModelStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
GetTariffs
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | EVSE id to get tariff from. When evseId = 0, this gets tariffs from all EVSEs. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | TariffGetStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| tariffAssignments | TariffAssignmentType[] | Optional | min items: 1 |
GetTransactionStatus
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| transactionId | string | Optional | max: 36 | The Id of the transaction for which the status is requested. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| ongoingIndicator | bool | Optional | Whether the transaction is still ongoing. | |
| messagesInQueue | bool | Required | Whether there are still message to be delivered. |
GetVariableDataType
Request
No properties
Response
No properties
GetVariableResultType
Request
No properties
Response
No properties
GetVariables
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| getVariableData | GetVariableDataType[] | Required | min items: 1 |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| getVariableResult | GetVariableResultType[] | Required | min items: 1 |
GradientGetType
Request
No properties
Response
No properties
GradientType
Request
No properties
Response
No properties
Heartbeat
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
No properties
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| currentTime | DateTime | Required | Contains the current time of the CSMS. |
HysteresisType
Request
No properties
Response
No properties
IdTokenInfoType
Request
No properties
Response
No properties
IdTokenType
Request
No properties
Response
No properties
InstallCertificate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| certificateType | InstallCertificateUseEnumType | Required | ||
| certificate | string | Required | max: 10000 | A PEM encoded X.509 certificate. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | InstallCertificateStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
LimitAtSoCType
Request
No properties
Response
No properties
LimitMaxDischargeGetType
Request
No properties
Response
No properties
LimitMaxDischargeType
Request
No properties
Response
No properties
LogParametersType
Request
No properties
Response
No properties
LogStatusNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | UploadLogStatusEnumType | Required | ||
| requestId | int | Optional | The request id that was provided in GetLogRequest that started this log upload. This field is mandatory, unless the message was triggered by a TriggerMessageRequest AND there is no log upload ongoing. | |
| statusInfo | StatusInfoType | Optional |
Response
No properties
MessageContentType
Request
No properties
Response
No properties
MessageInfoType
Request
No properties
Response
No properties
MeterValues
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | This contains a number (>0) designating an EVSE of the Charging Station. ‘0’ (zero) is used to designate the main power meter. | |
| meterValue | MeterValueType[] | Required | min items: 1 |
Response
No properties
MeterValueType
Request
No properties
Response
No properties
ModemType
Request
No properties
Response
No properties
MonitoringDataType
Request
No properties
Response
No properties
NetworkConnectionProfileType
Request
No properties
Response
No properties
NotifyAllowedEnergyTransfer
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| transactionId | string | Required | max: 36 | The transaction for which the allowed energy transfer is allowed. |
| allowedEnergyTransfer | EnergyTransferModeEnumType[] | Required | min items: 1 | Modes of energy transfer that are accepted by CSMS. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | NotifyAllowedEnergyTransferStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
NotifyChargingLimit
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingSchedule | ChargingScheduleType[] | Optional | min items: 1 | |
| evseId | int | Optional | The EVSE to which the charging limit is set. If absent or when zero, it applies to the entire Charging Station. | |
| chargingLimit | ChargingLimitType | Required |
Response
No properties
NotifyCustomerInformation
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| data | string | Required | max: 512 | (Part of) the requested data. No format specified in which the data is returned. Should be human readable. |
| tbc | bool | Optional | “to be continued” indicator. Indicates whether another part of the monitoringData follows in an upcoming notifyMonitoringReportRequest message. Default value when omitted is false. | |
| seqNo | int | Required | Sequence number of this message. First message starts at 0. | |
| generatedAt | DateTime | Required | Timestamp of the moment this message was generated at the Charging Station. | |
| requestId | int | Required | The Id of the request. |
Response
No properties
NotifyDERAlarm
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| controlType | DERControlEnumType | Required | ||
| gridEventFault | GridEventFaultEnumType | Optional | ||
| alarmEnded | bool | Optional | True when error condition has ended. Absent or false when alarm has started. | |
| timestamp | DateTime | Required | Time of start or end of alarm. | |
| extraInfo | string | Optional | max: 200 | Optional info provided by EV. |
Response
No properties
NotifyDERStartStop
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| controlId | string | Required | max: 36 | Id of the started or stopped DER control. Corresponds to the controlId of the SetDERControlRequest. |
| started | bool | Required | True if DER control has started. False if it has ended. | |
| timestamp | DateTime | Required | Time of start or end of event. | |
| supersededIds | string[] | Optional | min items: 1, max items: 24 | List of controlIds that are superseded as a result of this control starting. |
Response
No properties
NotifyDisplayMessages
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| messageInfo | MessageInfoType[] | Optional | min items: 1 | |
| requestId | int | Required | The id of the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>> that requested this message. | |
| tbc | bool | Optional | "to be continued" indicator. Indicates whether another part of the report follows in an upcoming NotifyDisplayMessagesRequest message. Default value when omitted is false. |
Response
No properties
NotifyEVChargingNeeds
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | Defines the EVSE and connector to which the EV is connected. EvseId may not be 0. | |
| maxScheduleTuples | int | Optional | Contains the maximum elements the EV supports for: + - ISO 15118-2: schedule tuples in SASchedule (both Pmax and Tariff). + - ISO 15118-20: PowerScheduleEntry, PriceRule and PriceLevelScheduleEntries. | |
| chargingNeeds | ChargingNeedsType | Required | ||
| timestamp | DateTime | Optional | (2.1) Time when EV charging needs were received. + Field can be added when charging station was offline when charging needs were received. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | NotifyEVChargingNeedsStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
NotifyEVChargingSchedule
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| timeBase | DateTime | Required | Periods contained in the charging profile are relative to this point in time. | |
| chargingSchedule | ChargingScheduleType | Required | ||
| evseId | int | Required | The charging schedule contained in this notification applies to an EVSE. EvseId must be > 0. | |
| selectedChargingScheduleId | int | Optional | (2.1) Id of the chargingSchedule that EV selected from the provided ChargingProfile. | |
| powerToleranceAcceptance | bool | Optional | (2.1) True when power tolerance is accepted by EV. This value is taken from EVPowerProfile.PowerToleranceAcceptance in the ISO 15118-20 PowerDeliverReq message.. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
NotifyEvent
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| generatedAt | DateTime | Required | Timestamp of the moment this message was generated at the Charging Station. | |
| tbc | bool | Optional | “to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyEventRequest message. Default value when omitted is false. | |
| seqNo | int | Required | Sequence number of this message. First message starts at 0. | |
| eventData | EventDataType[] | Required | min items: 1 |
Response
No properties
NotifyMonitoringReport
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| monitor | MonitoringDataType[] | Optional | min items: 1 | |
| requestId | int | Required | The id of the GetMonitoringRequest that requested this report. | |
| tbc | bool | Optional | “to be continued” indicator. Indicates whether another part of the monitoringData follows in an upcoming notifyMonitoringReportRequest message. Default value when omitted is false. | |
| seqNo | int | Required | Sequence number of this message. First message starts at 0. | |
| generatedAt | DateTime | Required | Timestamp of the moment this message was generated at the Charging Station. |
Response
No properties
NotifyPriorityCharging
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| transactionId | string | Required | max: 36 | The transaction for which priority charging is requested. |
| activated | bool | Required | True if priority charging was activated. False if it has stopped using the priority charging profile. |
Response
No properties
NotifyReport
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| requestId | int | Required | The id of the GetReportRequest or GetBaseReportRequest that requested this report | |
| generatedAt | DateTime | Required | Timestamp of the moment this message was generated at the Charging Station. | |
| reportData | ReportDataType[] | Optional | min items: 1 | |
| tbc | bool | Optional | “to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyReportRequest message. Default value when omitted is false. | |
| seqNo | int | Required | Sequence number of this message. First message starts at 0. |
Response
No properties
NotifySettlement
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| transactionId | string | Optional | max: 36 | The transactionId that the settlement belongs to. Can be empty if the payment transaction is canceled prior to the start of the OCPP transaction. |
| pspRef | string | Required | max: 255 | The payment reference received from the payment terminal and is used as the value for idToken. |
| status | PaymentStatusEnumType | Required | ||
| statusInfo | string | Optional | max: 500 | Additional information from payment terminal/payment process. |
| settlementAmount | decimal | Required | The amount that was settled, or attempted to be settled (in case of failure). | |
| settlementTime | DateTime | Required | The time when the settlement was done. | |
| receiptId | string | Optional | max: 50 | |
| receiptUrl | string | Optional | max: 2000 | The receipt URL, to be used if the receipt is generated by the payment terminal or the CS. |
| vatCompany | AddressType | Optional | ||
| vatNumber | string | Optional | max: 20 | VAT number for a company receipt. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| receiptUrl | string | Optional | max: 2000 | The receipt URL if receipt generated by CSMS. The Charging Station can QR encode it and show it to the EV Driver. |
| receiptId | string | Optional | max: 50 | The receipt id if the receipt is generated by CSMS. |
NotifyWebPaymentStarted
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | EVSE id for which transaction is requested. | |
| timeout | int | Required | Timeout value in seconds after which no result of web payment process (e.g. QR code scanning) is to be expected anymore. |
Response
No properties
OCSPDataType
Request
No properties
Response
No properties
OpenPeriodicEventStream
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| constantStreamData | ConstantStreamDataType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
OverstayRuleListType
Request
No properties
Response
No properties
OverstayRuleType
Request
No properties
Response
No properties
PeriodicEventStreamParamsType
Request
No properties
Response
No properties
PriceLevelScheduleEntryType
Request
No properties
Response
No properties
PriceLevelScheduleType
Request
No properties
Response
No properties
PriceRuleStackType
Request
No properties
Response
No properties
PriceRuleType
Request
No properties
Response
No properties
PriceType
Request
No properties
Response
No properties
PublishFirmware
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| location | string | Required | max: 2000 | This contains a string containing a URI pointing to a location from which to retrieve the firmware. |
| retries | int | Optional | This specifies how many times Charging Station must retry to download the firmware before giving up. If this field is not present, it is left to Charging Station to decide how many times it wants to retry. If the value is 0, it means: no retries. | |
| checksum | string | Required | max: 32 | The MD5 checksum over the entire firmware file as a hexadecimal string of length 32. |
| requestId | int | Required | The Id of the request. | |
| retryInterval | int | Optional | The interval in seconds after which a retry may be attempted. If this field is not present, it is left to Charging Station to decide how long to wait between attempts. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
PublishFirmwareStatusNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | PublishFirmwareStatusEnumType | Required | ||
| location | string[] | Optional | min items: 1 | Required if status is Published. Can be multiple URI’s, if the Local Controller supports e.g. HTTP, HTTPS, and FTP. |
| requestId | int | Optional | The request id that was provided in the PublishFirmwareRequest which triggered this action. | |
| statusInfo | StatusInfoType | Optional |
Response
No properties
PullDynamicScheduleUpdate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingProfileId | int | Required | Id of charging profile to update. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| scheduleUpdate | ChargingScheduleUpdateType | Optional | ||
| status | ChargingProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
RationalNumberType
Request
No properties
Response
No properties
ReactivePowerParamsType
Request
No properties
Response
No properties
RelativeTimeIntervalType
Request
No properties
Response
No properties
ReportChargingProfiles
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| requestId | int | Required | Id used to match the <<getchargingprofilesrequest, GetChargingProfilesRequest>> message with the resulting ReportChargingProfilesRequest messages. When the CSMS provided a requestId in the <<getchargingprofilesrequest, GetChargingProfilesRequest>>, this field SHALL contain the same value. | |
| chargingLimitSource | string | Required | max: 20 | Source that has installed this charging profile. Values defined in Appendix as ChargingLimitSourceEnumStringType. |
| chargingProfile | ChargingProfileType[] | Required | min items: 1 | |
| tbc | bool | Optional | To Be Continued. Default value when omitted: false. false indicates that there are no further messages as part of this report. | |
| evseId | int | Required | The evse to which the charging profile applies. If evseId = 0, the message contains an overall limit for the Charging Station. |
Response
No properties
ReportDataType
Request
No properties
Response
No properties
ReportDERControl
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| curve | DERCurveGetType[] | Optional | min items: 1, max items: 24 | |
| enterService | EnterServiceGetType[] | Optional | min items: 1, max items: 24 | |
| fixedPFAbsorb | FixedPFGetType[] | Optional | min items: 1, max items: 24 | |
| fixedPFInject | FixedPFGetType[] | Optional | min items: 1, max items: 24 | |
| fixedVar | FixedVarGetType[] | Optional | min items: 1, max items: 24 | |
| freqDroop | FreqDroopGetType[] | Optional | min items: 1, max items: 24 | |
| gradient | GradientGetType[] | Optional | min items: 1, max items: 24 | |
| limitMaxDischarge | LimitMaxDischargeGetType[] | Optional | min items: 1, max items: 24 | |
| requestId | int | Required | RequestId from GetDERControlRequest. | |
| tbc | bool | Optional | To Be Continued. Default value when omitted: false. + False indicates that there are no further messages as part of this report. |
Response
No properties
ReservationStatusUpdate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| reservationId | int | Required | The ID of the reservation. | |
| reservationUpdateStatus | ReservationUpdateStatusEnumType | Required |
Response
No properties
ReserveNow
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| id | int | Required | Id of reservation. | |
| expiryDateTime | DateTime | Required | Date and time at which the reservation expires. | |
| connectorType | string | Optional | max: 20 | This field specifies the connector type. Values defined in Appendix as ConnectorEnumStringType. |
| idToken | IdTokenType | Required | ||
| evseId | int | Optional | This contains ID of the evse to be reserved. | |
| groupIdToken | IdTokenType | Optional |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ReserveNowStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
Reset
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| type | ResetEnumType | Required | ||
| evseId | int | Optional | This contains the ID of a specific EVSE that needs to be reset, instead of the entire Charging Station. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ResetStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SalesTariffEntryType
Request
No properties
Response
No properties
SalesTariffType
Request
No properties
Response
No properties
SampledValueType
Request
No properties
Response
No properties
SecurityEventNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| type | string | Required | max: 50 | Type of the security event. This value should be taken from the Security events list. |
| timestamp | DateTime | Required | Date and time at which the event occurred. | |
| techInfo | string | Optional | max: 255 | Additional information about the occurred security event. |
Response
No properties
SendLocalList
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| localAuthorizationList | AuthorizationData[] | Optional | min items: 1 | |
| versionNumber | int | Required | In case of a full update this is the version number of the full list. In case of a differential update it is the version number of the list after the update has been applied. | |
| updateType | UpdateEnumType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | SendLocalListStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetChargingProfile
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | For TxDefaultProfile an evseId=0 applies the profile to each individual evse. For ChargingStationMaxProfile and ChargingStationExternalConstraints an evseId=0 contains an overal limit for the whole Charging Station. | |
| chargingProfile | ChargingProfileType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ChargingProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetDefaultTariff
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | EVSE that tariff applies to. When evseId = 0, then tarriff applies to all EVSEs. | |
| tariff | TariffType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | TariffSetStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetDERControl
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| isDefault | bool | Required | True if this is a default DER control | |
| controlId | string | Required | max: 36 | Unique id of this control, e.g. UUID |
| controlType | DERControlEnumType | Required | ||
| curve | DERCurveType | Optional | ||
| enterService | EnterServiceType | Optional | ||
| fixedPFAbsorb | FixedPFType | Optional | ||
| fixedPFInject | FixedPFType | Optional | ||
| fixedVar | FixedVarType | Optional | ||
| freqDroop | FreqDroopType | Optional | ||
| gradient | GradientType | Optional | ||
| limitMaxDischarge | LimitMaxDischargeType | Optional |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DERControlStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional | ||
| supersededIds | string[] | Optional | min items: 1, max items: 24 | List of controlIds that are superseded as a result of setting this control. |
SetDisplayMessage
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| message | MessageInfoType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | DisplayMessageStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetMonitoringBase
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| monitoringBase | MonitoringBaseEnumType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericDeviceModelStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetMonitoringDataType
Request
No properties
Response
No properties
SetMonitoringLevel
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| severity | int | Required | The Charging Station SHALL only report events with a severity number lower than or equal to this severity. The severity range is 0-9, with 0 as the highest and 9 as the lowest severity level. The severity levels have the following meaning: + 0-Danger + Indicates lives are potentially in danger. Urgent attention is needed and action should be taken immediately. + 1-Hardware Failure + Indicates that the Charging Station is unable to continue regular operations due to Hardware issues. Action is required. + 2-System Failure + Indicates that the Charging Station is unable to continue regular operations due to software or minor hardware issues. Action is required. + 3-Critical + Indicates a critical error. Action is required. + 4-Error + Indicates a non-urgent error. Action is required. + 5-Alert + Indicates an alert event. Default severity for any type of monitoring event. + 6-Warning + Indicates a warning event. Action may be required. + 7-Notice + Indicates an unusual event. No immediate action is required. + 8-Informational + Indicates a regular operational event. May be used for reporting, measuring throughput, etc. No action is required. + 9-Debug + Indicates information useful to developers for debugging, not useful during operations. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetMonitoringResultType
Request
No properties
Response
No properties
SetNetworkProfile
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| configurationSlot | int | Required | Slot in which the configuration should be stored. | |
| connectionData | NetworkConnectionProfileType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | SetNetworkProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SetVariableDataType
Request
No properties
Response
No properties
SetVariableMonitoring
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| setMonitoringData | SetMonitoringDataType[] | Required | min items: 1 |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| setMonitoringResult | SetMonitoringResultType[] | Required | min items: 1 |
SetVariableResultType
Request
No properties
Response
No properties
SetVariables
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| setVariableData | SetVariableDataType[] | Required | min items: 1 |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| setVariableResult | SetVariableResultType[] | Required | min items: 1 |
SignCertificate
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| csr | string | Required | max: 5500 | The Charging Station SHALL send the public key in form of a Certificate Signing Request (CSR) as described in RFC 2986 [22] and then PEM encoded, using the <<signcertificaterequest,SignCertificateRequest>> message. |
| certificateType | CertificateSigningUseEnumType | Optional | ||
| hashRootCertificate | CertificateHashDataType | Optional | ||
| requestId | int | Optional | (2.1) RequestId to match this message with the CertificateSignedRequest. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | GenericStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
SignedMeterValueType
Request
No properties
Response
No properties
StatusInfoType
Request
No properties
Response
No properties
StatusNotification
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| timestamp | DateTime | Required | The time for which the status is reported. | |
| connectorStatus | ConnectorStatusEnumType | Required | ||
| evseId | int | Required | The id of the EVSE to which the connector belongs for which the the status is reported. | |
| connectorId | int | Required | The id of the connector within the EVSE for which the status is reported. |
Response
No properties
StreamDataElementType
Request
No properties
Response
No properties
TariffAssignmentType
Request
No properties
Response
No properties
TariffConditionsFixedType
Request
No properties
Response
No properties
TariffConditionsType
Request
No properties
Response
No properties
TariffEnergyPriceType
Request
No properties
Response
No properties
TariffEnergyType
Request
No properties
Response
No properties
TariffFixedPriceType
Request
No properties
Response
No properties
TariffFixedType
Request
No properties
Response
No properties
TariffTimePriceType
Request
No properties
Response
No properties
TariffTimeType
Request
No properties
Response
No properties
TariffType
Request
No properties
Response
No properties
TaxRateType
Request
No properties
Response
No properties
TaxRuleType
Request
No properties
Response
No properties
TotalCostType
Request
No properties
Response
No properties
TotalPriceType
Request
No properties
Response
No properties
TotalUsageType
Request
No properties
Response
No properties
TransactionEvent
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| costDetails | CostDetailsType | Optional | ||
| eventType | TransactionEventEnumType | Required | ||
| meterValue | MeterValueType[] | Optional | min items: 1 | |
| timestamp | DateTime | Required | The date and time at which this transaction event occurred. | |
| triggerReason | TriggerReasonEnumType | Required | ||
| seqNo | int | Required | Incremental sequence number, helps with determining if all messages of a transaction have been received. | |
| offline | bool | Optional | Indication that this transaction event happened when the Charging Station was offline. Default = false, meaning: the event occurred when the Charging Station was online. | |
| numberOfPhasesUsed | int | Optional | range: 0.0..3.0 | If the Charging Station is able to report the number of phases used, then it SHALL provide it. When omitted the CSMS may be able to determine the number of phases used as follows: + 1: The numberPhases in the currently used ChargingSchedule. + 2: The number of phases provided via device management. |
| cableMaxCurrent | int | Optional | The maximum current of the connected cable in Ampere (A). | |
| reservationId | int | Optional | This contains the Id of the reservation that terminates as a result of this transaction. | |
| preconditioningStatus | PreconditioningStatusEnumType | Optional | ||
| evseSleep | bool | Optional | (2.1) True when EVSE electronics are in sleep mode for this transaction. Default value (when absent) is false. | |
| transactionInfo | TransactionType | Required | ||
| evse | EVSEType | Optional | ||
| idToken | IdTokenType | Optional |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| totalCost | decimal | Optional | When eventType of TransactionEventRequest is Updated, then this value contains the running cost. When eventType of TransactionEventRequest is Ended, then this contains the final total cost of this transaction, including taxes, in the currency configured with the Configuration Variable: Currency. Absence of this value does not imply that the transaction was free. To indicate a free transaction, the CSMS SHALL send a value of 0.00. | |
| chargingPriority | int | Optional | 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>> has a higher priority than the one in <<cmn_idtokeninfotype,IdTokenInfoType>>. | |
| idTokenInfo | IdTokenInfoType | Optional | ||
| transactionLimit | TransactionLimitType | Optional | ||
| updatedPersonalMessage | MessageContentType | Optional | ||
| updatedPersonalMessageExtra | MessageContentType[] | Optional | min items: 1, max items: 4 |
TransactionLimitType
Request
No properties
Response
No properties
TransactionType
Request
No properties
Response
No properties
TriggerMessage
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evse | EVSEType | Optional | ||
| requestedMessage | MessageTriggerEnumType | Required | ||
| customTrigger | string | Optional | max: 50 | (2.1) When requestedMessage = CustomTrigger this will trigger sending the corresponding message in field customTrigger, if supported by Charging Station. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | TriggerMessageStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
UnitOfMeasureType
Request
No properties
Response
No properties
UnlockConnector
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| evseId | int | Required | This contains the identifier of the EVSE for which a connector needs to be unlocked. | |
| connectorId | int | Required | This contains the identifier of the connector that needs to be unlocked. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | UnlockStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
UnpublishFirmware
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| checksum | string | Required | max: 32 | The MD5 checksum over the entire firmware file as a hexadecimal string of length 32. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | UnpublishFirmwareStatusEnumType | Required |
UpdateDynamicSchedule
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| chargingProfileId | int | Required | Id of charging profile to update. | |
| scheduleUpdate | ChargingScheduleUpdateType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | ChargingProfileStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
UpdateFirmware
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| retries | int | Optional | This specifies how many times Charging Station must retry to download the firmware before giving up. If this field is not present, it is left to Charging Station to decide how many times it wants to retry. If the value is 0, it means: no retries. | |
| retryInterval | int | Optional | The interval in seconds after which a retry may be attempted. If this field is not present, it is left to Charging Station to decide how long to wait between attempts. | |
| requestId | int | Required | The Id of this request | |
| firmware | FirmwareType | Required |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | UpdateFirmwareStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
UsePriorityCharging
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| transactionId | string | Required | max: 36 | The transaction for which priority charging is requested. |
| activate | bool | Required | True to request priority charging. False to request stopping priority charging. |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| status | PriorityChargingStatusEnumType | Required | ||
| statusInfo | StatusInfoType | Optional |
V2XChargingParametersType
Request
No properties
Response
No properties
V2XFreqWattPointType
Request
No properties
Response
No properties
V2XSignalWattPointType
Request
No properties
Response
No properties
VariableAttributeType
Request
No properties
Response
No properties
VariableCharacteristicsType
Request
No properties
Response
No properties
VariableMonitoringType
Request
No properties
Response
No properties
VariableType
Request
No properties
Response
No properties
VatNumberValidation
OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License
Request
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| vatNumber | string | Required | max: 20 | VAT number to check. |
| evseId | int | Optional | EVSE id for which check is done |
Response
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
| company | AddressType | Optional | ||
| statusInfo | StatusInfoType | Optional | ||
| vatNumber | string | Required | max: 20 | VAT number that was requested. |
| evseId | int | Optional | EVSE id for which check was requested. | |
| status | GenericStatusEnumType | Required |
VoltageParamsType
Request
No properties
Response
No properties
VPNType
Request
No properties
Response
No properties