Skip to content
Documentation Menu

Send Local List

Source: OCPP 1.6 Specification — Section 5.15 (Operation), Sections 6.41 / 6.42 (Messages)

Overview

Central System can send a Local Authorization List that a Charge Point can use for authorization of idTags. The list MAY be either a full list to replace the current list in the Charge Point or it MAY be a differential list with updates to be applied to the current list in the Charge Point.

The Central System SHALL send a SendLocalList.req PDU to send the list to a Charge Point. The SendLocalList.req PDU SHALL contain the type of update (full or differential) and the version number that the Charge Point MUST associate with the local authorization list after it has been updated.

Upon receipt of a SendLocalList.req PDU, the Charge Point SHALL respond with a SendLocalList.conf PDU. The response PDU SHALL indicate whether the Charge Point has accepted the update of the local authorization list. If the status is Failed or VersionMismatch and the updateType was Differential, then the Central System SHOULD retry sending the full local authorization list with updateType = Full.

If no (empty) localAuthorizationList is given and the updateType is Full, all identifications are removed from the list. Requesting a Differential update without (empty) localAuthorizationList will have no effect on the list. All idTags in the localAuthorizationList MUST be unique, no duplicate values are allowed.

Sequence Diagram

Figure 36. Sequence Diagram: Send Local List

Central System  ──── SendLocalList.req ────▶  Charge Point
                     (listVersion, localAuthorizationList[]?, updateType)
Central System  ◀─── SendLocalList.conf ────  Charge Point
                     (status)

Initiator

Central System → Charge Point

Fields

Field NameField TypeCard.Description
listVersioninteger1..1Required. 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.
localAuthorizationListAuthorizationData0..*Optional. In case of a full update this contains the list of values that form the new local authorization list. In case of a differential update it contains the changes to be applied to the local authorization list in the Charge Point. Maximum number of AuthorizationData elements is available in the configuration key SendLocalListMaxLength.
updateTypeUpdateType1..1Required. This contains the type of update (full or differential) of this request.

UpdateType values

  • Differential — Indicates that the current Local Authorization List must be updated with the values in this message.
  • Full — Indicates that the current Local Authorization List must be replaced by the values in this message.

UpdateStatus values

  • Accepted — Local Authorization List successfully updated.
  • Failed — Failed to update the Local Authorization List.
  • NotSupported — Update of Local Authorization List is not supported by Charge Point.
  • VersionMismatch — Version number in the request for a differential update is less or equal then version number of current list.

Examples

{
  "status": "Accepted"
}
  • SendLocalListMaxLength — Maximum number of AuthorizationData elements in SendLocalList.req.
  • LocalAuthListMaxLength — Maximum number of identifications stored in the Local Authorization List.
  • LocalAuthListEnabled — Whether the Local Authorization List is enabled.

Schema

Source: schemas/SendLocalList.json, schemas/SendLocalListResponse.json (OCPP 1.6, JSON Schema draft-04)

Request schema (JSON Schema)
Response schema (JSON Schema)