Versions

OCPI 2.2.1

By Abhishek Uniyal · Updated

Versions in OCPI 2.2.1

The Versions module tells a platform which OCPI versions and module URLs its partner offers. Follow the supplied Versions URL and the Version.url returned for the negotiated version. This first object is one Version entry; the second is VersionDetails. Request Locations at its advertised Endpoint.url, not a path guessed from the protocol version. Optional modules that were not advertised are not prerequisites. Endpoint.role names SENDER or RECEIVER interfaces, not market roles. The Credentials role value has no function and can be disregarded.

Sources (8)
version · VersionNumber · cardinality 1: The version number. url · URL · cardinality 1: URL to the endpoint containing version specific information.OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_version_classidentifier · ModuleID · cardinality 1: Endpoint identifier. role · InterfaceRole · cardinality 1: Interface role this endpoint implements. url · URL · cardinality 1: URL to the endpoint.OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_endpoint_classversion · VersionNumber · cardinality 1: The version number. endpoints · Endpoint · cardinality +: A list of supported endpoints for this version.OCPI 2.2.1 Version information endpoint chapter · #version_information_get_details_endpoint_data"This endpoint lists all the available OCPI versions and the corresponding URLs to where version specific details such as the supported endpoints can be found."OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_version_information_endpoint"The Module identifiers for each endpoint are described in the beginning of each _Module_ chapter. The following table contains the list of modules in this version of OCPI. Most modules (except Credentials & Registration) are optional, but there might be dependencies between modules. If there are dependencies between modules, it will be mentioned in the affected module description."OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_moduleid_enum"Via the version details, the parties can exchange which modules are implemented for a specific version of OCPI, which interface role is implemented, and what the endpoint URL is for this interface."OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_version_details_endpointSENDER: Sender Interface implementation. Interface implemented by the owner of data, so the Receiver can Pull information from the data Sender/owner. RECEIVER: Receiver Interface implementation. Interface implemented by the receiver of data, so the Sender/owner can Push information to the Receiver.OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_interface_role_enum"NOTE: for the `credentials` module, the value of the role property is not relevant as this module is the same for all roles. It is advised to send "SENDER" as the InterfaceRole for one's own credentials endpoint and to disregard the value of the role property of the Endpoint object for other platforms' credentials modules."OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_endpoint_class

Example payload · version-entry

{
  "version": "2.2.1",
  "url": "https://peer.example.invalid/discovery/release-info"
}

Example payload · version-details

{
  "version": "2.2.1",
  "endpoints": [
    {
      "identifier": "credentials",
      "url": "https://peer.example.invalid/access/registration",
      "role": "SENDER"
    },
    {
      "identifier": "locations",
      "url": "https://peer.example.invalid/charge-sites",
      "role": "SENDER"
    }
  ]
}
Follow OCPI version discovery

Which endpoints does this module define?

These paths illustrate the requests. Use the URLs advertised by your partner, replace the placeholders and choose the matching interface. A listed method does not establish that this site's simulator implements it.

All parties

  • Discover supported versions.

    GET
    /ocpi/versions
Source
GET: Fetch information about the supported versions.OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_version_information_endpoint

All parties

  • Discover module URLs for a version.

    GET
    /ocpi/2.2.1/
Source
GET: Fetch information about the supported endpoints for this version.OCPI 2.2.1 Version information endpoint chapter · #version_information_endpoint_version_details_endpoint

Try an endpoint

Send a request to this site's OCPI endpoints and read the answer. It never reaches your own system.