OCPP 2.0.1 Schemas — Transactions

Functional Block: D

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

• TransactionEvent (CS → CSMS)
• RequestStartTransaction (CSMS → CS)
• RequestStopTransaction (CSMS → CS)
• GetTransactionStatus (CSMS → CS)
• MeterValues (CS → CSMS)

#TransactionEvent

Direction: CS → CSMS

#TransactionEventRequest

{
  "eventType": "Ended",
  "seqNo": 0,
  "timestamp": "2024-01-15T10:30:00Z",
  "transactionInfo": {
    "transactionId": "string"
  },
  "triggerReason": "Authorized"
}

#TransactionEventResponse

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

#RequestStartTransaction

Direction: CSMS → CS

#RequestStartTransactionRequest

{
  "idToken": {
    "idToken": "string",
    "type": "Central"
  },
  "remoteStartId": 0
}

#RequestStartTransactionResponse

#RequestStopTransaction

Direction: CSMS → CS

#RequestStopTransactionRequest

{
  "transactionId": "string"
}

#RequestStopTransactionResponse

#GetTransactionStatus

Direction: CSMS → CS

#GetTransactionStatusRequest

#GetTransactionStatusResponse

#MeterValues

Direction: CS → CSMS

#MeterValuesRequest

{
  "evseId": 0,
  "meterValue": [
    {
      "timestamp": "2024-01-15T10:30:00Z",
      "sampledValue": [
        "{...}"
      ]
    }
  ]
}

#MeterValuesResponse

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

#Local Types

Types used only within this block's messages.

#ChargingStateEnumType

Current charging state, is required when state has changed.

Used in: TransactionEvent

#LocationEnumType

Indicates where the measured value has been sampled. Default = "Outlet"

Default: Outlet

Used in: MeterValues, TransactionEvent

#MeasurandEnumType

Type of measurement. Default = "Energy.Active.Import.Register"

Default: Energy.Active.Import.Register

Used in: MeterValues, TransactionEvent

#PhaseEnumType

Indicates how the measured value is to be interpreted. For instance between L1 and neutral (L1-N) Please note that not all values of phase are applicable to all Measurands. When phase is absent, the measured value is interpreted as an overall value.

Used in: MeterValues, TransactionEvent

#ReadingContextEnumType

Type of detail value: start, end or sample. Default = "Sample.Periodic"

Default: Sample.Periodic

Used in: MeterValues, TransactionEvent

#ReasonEnumType

This contains the reason why the transaction was stopped. MAY only be omitted when Reason is "Local".

Used in: TransactionEvent

#RequestStartStopStatusEnumType

Status indicating whether the Charging Station accepts the request to start a transaction.

Used in: RequestStartTransaction, RequestStopTransaction

#TransactionEventEnumType

This contains the type of this event. The first TransactionEvent of a transaction SHALL contain: "Started" The last TransactionEvent of a transaction SHALL contain: "Ended" All others SHALL contain: "Updated"

Used in: TransactionEvent

#TriggerReasonEnumType

Reason the Charging Station sends this message to the CSMS

Used in: TransactionEvent

#MeterValueType

Collection of one or more sampled values in MeterValuesRequest and TransactionEvent. All sampled values in a MeterValue are sampled at the same point in time.

Used in: MeterValues, TransactionEvent

#SampledValueType

Single sampled value in MeterValues. Each value can be accompanied by optional fields. To save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.

Used in: MeterValues, TransactionEvent

#SignedMeterValueType

Represent a signed version of the meter value.

Used in: MeterValues, TransactionEvent

#TransactionType

Used in: TransactionEvent

#UnitOfMeasureType

Represents a UnitOfMeasure with a multiplier

Used in: MeterValues, TransactionEvent