Datastructures
--------------

.. csv-table:: Rate
   :file: rate_object.csv
   :widths: 20 20 10 50
   :header-rows: 1


.. list-table:: Paginated Response
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - pagination
     - Pagination Object
     - 1
     - Pagination object, which contains information for fetching the next page
   * - data
     - Map<String, Rate>
     - 1
     - Map of evse ids to their resolved rate objects

.. list-table:: Pagination Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - nextCursorId
     - string
     - 1
     - pager string which can be passed for the next page to fetch
   * - isLastPage
     - boolean
     - 1
     - Indicator if this was the last page received (`true` if last page otherwise `false`)

.. list-table:: Price Structure Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - energy
     - Type Energy / Time Object
     - 1
     - Energy based cost rate
   * - time
     - Type Energy / Time Object
     - 1
     - Time based cost rate
   * - sessionFee
     - Type Session Fee Object
     - 1
     - Session Fee based cost rate


.. list-table:: Price Structure Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - unit
     - String
     - 1
     - The unit of the price structure object. energy → Wh, time → min.
   * - elements
     - Element[]
     - 1..*
     - The interval cost elements
   * - tax
     - Double
     - ?
     - Not present if include_tax parameter is not set

.. list-table:: Element Object
   :widths: 20 20 10 30 20
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
     - Unit
   * - intervalChange
     - int
     - 1
     - 	Interval change in Wh or min.
     - Wh or s respectively
   * - stepCosts
     - number
     - 1
     - Cost per kWh or min
     - currency
   * - intervalCosts
     - number
     - 1
     - Costs for this interval
     - Currency(e.g. €)/kWh or currency/min respectively

.. list-table:: Session Fee Object
   :widths: 20 20 10 30 20
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
     - Unit
   * - value
     - number
     - 1
     - Cost of session fee in localCurrency
     - localCurrency defined in the response
   * - gracePeriod
     - int
     - 1
     - Minimum time in seconds that is required to apply session fee. Both gracePeriod and minimumEnergyConsumption conditions need to satisfied to apply session fee
     - seconds
   * - minimumEnergyConsumption
     - int
     - 1
     - Minimum energy in Wh that is required to apply session fee. Both gracePeriod and minimumEnergyConsumption conditions need to satisfied to apply session fee
     - Wh

.. list-table:: Validity Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - type
     - String
     - 1
     - ``unique``, ``recurring``, or ``default``. Determines which of the remaining fields are present.
   * - start
     - String
     - ?
     - ``unique`` and unique-rate ``default``. Start of the window on the station clock, no marker.
   * - end
     - String
     - ?
     - ``unique`` and unique-rate ``default``. End on the station clock, no marker: the next entry that starts the same day, or ``23:59:59`` of that day.
   * - weekdays
     - Weekday Entry[]
     - ?
     - ``recurring`` only. The slot applicable at the requested time (a single entry), not the whole schedule.
   * - weekday
     - int
     - ?
     - recurring-rate ``default`` only. 0: Sunday … 6: Saturday.
   * - weekday_name
     - String
     - ?
     - recurring-rate ``default`` only. Three-letter weekday, e.g. ``THU``.
   * - start_time
     - String
     - ?
     - recurring-rate ``default`` only. Start of the gap window, ``HH:MM``.
   * - end_time
     - String
     - ?
     - recurring-rate ``default`` only. End of the gap window, ``HH:MM``.

The ``default`` type is the cost rate's fallback price where no schedule entry
covers. It carries no schedule uuid (``scheduleUuid`` is null). On a recurring
rate the window is a weekday and an ``HH:MM`` range; on a unique-date rate it
is a ``start`` and ``end`` bounded by one station-local day — the part of a
day before its first entry, or the whole day where no entry starts on it.

.. list-table:: Weekday Entry Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - uuid
     - String
     - 1
     - UUID of the recurring schedule config for this weekday/time slot.
   * - weekday
     - int
     - 1
     - 0: Sunday … 6: Saturday.
   * - weekday_name
     - String
     - 1
     - Three-letter weekday, e.g. ``THU``.
   * - start_time
     - String
     - 1
     - Slot start, ``HH:MM``.
   * - end_time
     - String
     - 1
     - Slot end, ``HH:MM``.

.. list-table:: NextPrice Object
   :widths: 20 20 10 50
   :header-rows: 1

   * - Property
     - Type
     - Cardinality
     - Description
   * - scheduleUuid
     - String
     - ?
     - UUID of the next schedule entry. null when the next window is the cost rate's default price: a gap after the current recurring slot, or a stretch of a unique-date day that no entry covers.
   * - validity
     - Validity Object
     - 1
     - Validity of the next entry.
   * - priceStructure
     - Price Structure Object
     - 1
     - Price of the next entry, in the same model as the current price.