Conventions

Need for Conventions

The NPP is based on the APDS standard data model and the APDS-defined API. There are however situations where the implementing parties need to agree upon conventions. The same applies to the configuration of an operator's inventory (locations, tariffs, charging hours).

Examples are:

  • which set of enumeration values to use (where APDS defines more than needed by the NPP)
  • how to handle edge cases (e.g. boundaries of from/to time ranges)
  • which set of classes and API endpoints to use (the NPP e.g. does currently not make use of the APDS Observation and Quotes domains)
  • which set of eligibity criteria to use

Identified Required Conventions

This section provides the already identified and agreed-upon conventions in the NPP context.

Indicative Point Location

The APDS property indicativePointLocation of a parking location shall be specified/interpreted as the car park's main entrance or centre of street (by length) or centre of parking bay.

Weeks

The first day of a week is Monday.

Validity End Times

If determined as same as start of next validity, always 0.001 minute before stated time. E.g. validity 1 is 10:00 to 18:00, validity 2 is 18:00 to 22:00 shall be interpreted as validity 1 from 10:00 to 17:59.999 and validity 2 from 18:00 to 22:00.

Energy Source Types

More and more operators introduce tariffs that differentiate by a vehicle's energy source. APDS defines a wide range of source types not all of which are used within the NPP context.

  • For petrol-powered vehicles, the NPP only differentiates between petrol and petrolBatteryHybrid. Specialisations concerning octane and lead are not used, they all fall under the petrol categorisation.
  • The same applies to the Diesel energy source. The NPP only differentiates between diesel and dieselBatteryHybrid. Hence, biodiesel counts as diesel.
  • The NPP only uses lpg, and liquidGas counts as lpg.
  • Fully electric vehicles are categorised as battery.
  • The unknown enum is used in all situations where the energy source is either unknown/uncategorised or cannot be otherwise categorised (using the set of APDS-defined enumeration values).
  • There is currently no NPP use case where the all categorisation would be required.
  • The other category is not used, because it creates contextual dependencies.

Recent Posts