Merge pull request #8 from parkingdata/3.0

3.0

api/models/api/HierarchyElementData.yaml

@@ -2,9 +2,11 @@ title: HierarchyElementData
 oneOf:
   - $ref: ../place/hierarchy/Campus.yaml
   - $ref: ../place/hierarchy/Place.yaml
-  - $ref: ../place/hierarchy/HierarchyElement.yaml
+  - $ref: ../place/hierarchy/SubplaceElement.yaml
   - $ref: ../place/hierarchy/IdentifiedArea.yaml
   - $ref: ../place/hierarchy/Space.yaml
+  - $ref: ../place/hierarchy/SupplementalEquipment.yaml
+  - $ref: ../place/hierarchy/SupplementalServiceFacility.yaml
 description: Represents an API data exchange model with any of the `Place` hierarchy types
 x-tags:
   - api

api/models/code_lists/ReferencedCodeListEntry.yaml

@@ -0,0 +1,13 @@
+title: ReferencedCodeListEntry
+type: object
+description: Class providing structure to support reference to an entry in a previously defined user-defined code list.
+properties:
+  codeListEntryId:
+    $ref: ../common/Reference.yaml
+  codeListId:
+    $ref: ../common/VersionedReference.yaml
+  entryDefinedValue:
+    type: string
+    description: free-text defined text (name) for the code list entry being referenced
+required:
+  - entryDefinedValue

api/models/code_lists/UserDefinedCodeList.yaml

@@ -0,0 +1,22 @@
+title: UserDefinedCodeList
+type: object
+description: Class providing structure to support a user-defined code list.
+properties:
+  creator:
+    $ref: ../common/VersionedReference.yaml
+  includeNilReasonType:
+    type: string
+    description: 'Boolean: [TRUE] indicates the NilReasonType list shall be included in this user defined code list.'
+  locator:
+    $ref: ../common/Url.yaml
+  userDefinedCodeListEntries:
+    type: array
+    minItems: 1
+    description: User defined code list entries
+    items:
+      $ref: ./UserDefinedCodeListEntry.yaml
+required:
+  - creator
+  - includeNilReasonType
+  - locator
+  - userDefinedCodeListEntries

api/models/code_lists/UserDefinedCodeListEntry.yaml

@@ -0,0 +1,16 @@
+title: UserDefinedCodeListEntry
+type: object
+description: Class providing structure to support a specific entry within a user-defined code list.
+properties:
+  definedValue:
+    type: string
+    description: free-text defined text (name) for the code list entry being referenced
+  entryDescription:
+    type: string
+    description: free-text description (explanation) for the code list entry being referenced
+  entryIndex:
+    type: integer
+    description: index number (integer) for the code list entry being referenced
+required:
+  - definedValue
+  - entryIndex

api/models/common/AmountInCurrency.yaml

@@ -0,0 +1,13 @@
+title: AmountInCurrency
+type: object
+description: A class supporting the definition of a unit of currency in a defined currency.
+properties:
+  currencyType:
+    $ref: ./CurrencyCode.yaml
+  currencyValue:
+    type: number
+    description: The amount of currency specified in the given currency code type.
+    format: float
+required:
+  - currencyType
+  - currencyValue

api/models/common/Ampere.yaml

@@ -0,0 +1,3 @@
+title: Ampere
+type: number
+description: Current

api/models/common/SafetyStandardClassification.yaml

@@ -0,0 +1,8 @@
+title: SafetyStandardClassification
+type: object
+properties:
+  securityFeature:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+  securityLevel:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+description: Use this class to classification type/level for security schemes for a place

api/models/common/Units.yaml

@@ -0,0 +1,3 @@
+title: Units
+type: number
+description: 'Amount in units,which are specified by unitTypeEnum.'

api/models/common/Volt.yaml

@@ -0,0 +1,2 @@
+title: Volt
+type: number

api/models/common/Watt.yaml

@@ -0,0 +1,2 @@
+title: Watt
+type: number

api/models/eligibility/Eligibility.yaml

@@ -15,3 +15,7 @@ allOf:
         description: Criteria to be eligible
         items:
           $ref: ./Qualification.yaml
+      rightHolders:
+        type: array
+        items:
+          $ref: ../right/RightHolder.yaml

api/models/eligibility/Emissions.yaml

@@ -4,8 +4,8 @@ x-tags:
   - eligibility
 description: Emission characteristics of vehicles.
 properties:
-  emissionClassificationEuro:
-    $ref: ../enums/EmissionClassificationEuroEnum.yaml
+  emissionClassification:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
   emissionClassificationOthers:
     type: array
     description: Some other (probably locally defined) value(s) for emission classification.

api/models/eligibility/Qualification.yaml

@@ -6,11 +6,11 @@ description: A singular set of criteria used to test eligibility for use of a ra
 properties:
   activeAssignedRight:
     $ref: ../common/Reference.yaml
-  fuelTypes:
+  propulsionEnergyType:
     type: array
     description: Indicates eligible fuel types for applicable  vehicles
     items:
-      $ref: ../enums/FuelTypeEnum.yaml
+      $ref: ../enums/EnergySourceEnum.yaml
   memberOfOtherRateTable:
     type: boolean
     description: 'Indicates if this qualification can be used in  combination with the use of another rate table. [TRUE]= member of (i.e., used) another rate table.'
@@ -24,11 +24,6 @@ properties:
     description: Free-text description of other rate table membership
     items:
       type: string
-  vehicleTypes:
-    type: array
-    description: Indicates the eligible vehicle types
-    items:
-      $ref: ../enums/VehicleTypeEnum.yaml
   withMembership:
     type: boolean
     description: 'indicates that a membership is required. [TRUE] membership required'
@@ -51,29 +46,48 @@ properties:
       $ref: ./AssignRightTime.yaml
   grossWeightCharacteristics:
     type: array
-    description: "Qualify based on the vehicle's min/max gross weight characteristics"
+    description: Qualify based on the vehicle's min/max gross weight characteristics
     uniqueItems: true
     maxItems: 2
     items:
       $ref: ./GrossWeightCharacteristic.yaml
   heightCharacteristics:
     type: array
-    description: "Qualify based on the vehicle's min/max height characteristics"
+    description: Qualify based on the vehicle's min/max height characteristics
     uniqueItems: true
     maxItems: 2
     items:
       $ref: ./HeightCharacteristic.yaml
   lengthCharacteristics:
     type: array
-    description: "Qualify based on the vehicle's min/max gross length characteristics"
+    description: Qualify based on the vehicle's min/max gross length characteristics
     uniqueItems: true
     maxItems: 2
     items:
       $ref: ./LengthCharacteristic.yaml
   widthCharacteristics:
     type: array
-    description: "Qualify based on the vehicle's min/max gross width characteristics"
+    description: Qualify based on the vehicle's min/max gross width characteristics
     uniqueItems: true
     maxItems: 2
     items:
       $ref: ./WidthCharacteristic.yaml
+  vehicleLoads:
+    type: array
+    description: The types of load carried by the vehicle
+    items:
+      $ref: ./VehicleLoad.yaml
+  userQualifications:
+    type: array
+    description: User-defined user groups qualification
+    items:
+      $ref: ./UserQualification.yaml
+  freeToPark:
+    type: boolean
+    description: 'specific parking is free or not. [TRUE] = free to park'
+  vehicleTypes:
+    type: array
+    description: |
+      The types of vehicles that qualify
+    items:
+      $ref: ./VehicleType.yaml

api/models/eligibility/UserGroup.yaml

@@ -0,0 +1,8 @@
+title: UserGroup
+type: object
+description: Class providing references to a specific user group with reference to enumerations available in the UserGroupEnum enumerated list.
+properties:
+  userType:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+required:
+  - userType

api/models/eligibility/UserQualification.yaml

@@ -0,0 +1,8 @@
+title: UserQualification
+type: object
+description: Class supporting the definition of user group characteristics
+properties:
+  userGroup:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+required:
+  - userGroup

api/models/eligibility/VehicleLoad.yaml

@@ -0,0 +1,8 @@
+title: VehicleLoad
+type: object
+description: Class defining load types carried by vehicles
+properties:
+  loadType:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+required:
+  - loadType

api/models/eligibility/VehicleType.yaml

@@ -0,0 +1,8 @@
+title: VehicleType
+type: object
+description: Class supporting the definition of user group characteristics
+properties:
+  vehicleType:
+    $ref: ../code_lists/ReferencedCodeListEntry.yaml
+required:
+  - vehicleType

api/models/energy_infrastructure/Connector.yaml

@@ -0,0 +1,27 @@
+title: Connector
+type: object
+description: Parameters and description of an interface that is available at the given electric charging point to connect vehicles
+properties:
+  chargingMode:
+    $ref: ../enums/ChargingModeEnum.yaml
+  connectorFormat:
+    $ref: ../enums/ConnectorFormatTypeEnum.yaml
+  connectorType:
+    $ref: ../enums/ConnectorTypeEnum.yaml
+  countryOfDomesticSocket:
+    type: array
+    description: Countries for which the domestic socket is applicable. Only needed if explicit type of a domestic socket is not specified.
+    items:
+      $ref: ../common/CountryCode.yaml
+  maximumCurrent:
+    $ref: ../common/Ampere.yaml
+  maxPowerAtSocket:
+    $ref: ../common/Watt.yaml
+  otherConnector:
+    type: string
+    description: Some other connector / charging interface
+  voltage:
+    $ref: ../common/Volt.yaml
+required:
+  - connectorType
+  - maxPowerAtSocket

api/models/energy_infrastructure/ElectricChargingEquipment.yaml

@@ -0,0 +1,10 @@
+title: ElectricChargingEquipment
+description: A specialisation to the SupplementalFacility class adding an ElectricChargingPoint.
+allOf:
+  - $ref: ../place/hierarchy/SupplementalFacility.yaml
+  - type: object
+    properties:
+      electricChargingPoint:
+        $ref: ./ElectricChargingPoint.yaml
+    required:
+      - electricChargingPoint

api/models/energy_infrastructure/ElectricChargingPoint.yaml

@@ -0,0 +1,37 @@
+title: ElectricChargingPoint
+description: A charging point for electric vehicles (EV).
+allOf:
+  - type: object
+    properties:
+      availableChargingPower:
+        type: array
+        description: Possible degrees of charging power in Watts.
+        items:
+          $ref: ../common/Watt.yaml
+      externalIdentifier:
+        type: string
+        description: A unique string to identify the charging point.
+      usageType:
+        type: array
+        description: Usage type of the electric charging point.
+        items:
+          $ref: ../enums/ChargingPointUsageTypeEnum.yaml
+      vehicleToGridCommunicationType:
+        type: array
+        description: Type of vehicle to grid communication used
+        items:
+          $ref: ../enums/VehicleToGridCommunicationTypeEnum.yaml
+      availableVoltage:
+        type: array
+        description: Possible degrees of voltage
+        items:
+          $ref: ../common/Volt.yaml
+      connectors:
+        type: array
+        minItems: 1
+        description: Specify the connector(s).
+        items:
+          $ref: ./Connector.yaml
+    required:
+      - connectors
+  - $ref: ./RefillPoint.yaml

api/models/energy_infrastructure/RefillPoint.yaml

@@ -0,0 +1,39 @@
+title: RefillPoint
+type: object
+description: Technical infrastructure at a specific location that facilitates an energy refilling process being connected to max. one vehicle at a time
+properties:
+  authenticationAndIdentificationMethods:
+    type: array
+    description: Information on what methods of identification and/or authentication are accepted
+    items:
+      $ref: ../enums/AuthenticationAndIdentificationEnum.yaml
+  currencyOverride:
+    type: array
+    description: Information on which currency/currencies can be used to pay
+    items:
+      $ref: ../common/CurrencyCode.yaml
+  deliveryUnit:
+    $ref: ../enums/DeliveryUnitEnum.yaml
+  maximumDeliveryAmount:
+    $ref: ../common/Units.yaml
+  minimumDeliveryAmount:
+    $ref: ../common/Units.yaml
+  modelType:
+    $ref: ../common/MultilingualString.yaml
+  refillPointIndex:
+    type: integer
+    description: An index to link this element between the static and dynamic publications.
+  reservability:
+    $ref: ../enums/ReservationTypeEnum.yaml
+  serviceType:
+    type: array
+    description: Information on different service types for the fuelling/charging and payment process.
+    items:
+      $ref: ../enums/ServiceTypeEnum.yaml
+  userInterfaceLanguage:
+    type: array
+    description: 'Languages, in which a user interface is available, if any'
+    items:
+      $ref: ../common/LanguageCode.yaml
+required:
+  - refillPointIndex

api/models/enums/AddressLineTypeEnum.yaml

@@ -0,0 +1,24 @@
+type: string
+title: AddressLineTypeEnum
+enum:
+  - apartment
+  - building
+  - districtTerritory
+  - floor
+  - poBox
+  - region
+  - street
+  - town
+  - unit
+description: |-
+  A table of types of address lines
+
+   * `apartment`: Element indicating a discrete element of a building forming the address
+   * `building`: Element identifying the number or name and type of the edifice or construction relevant for the address [derived from ISO19160-4]
+   * `districtTerritory`: Element specifying the geographic or administrative area of the country for the address [Source: 19160-4]
+   * `floor`: Element indicating the floor or level on which a delivery point is located in a multi-storey building [Source:ISO19160-4]
+   * `poBox`: A postal delivery location identifier, not necessarily a physical location.
+   * `region`: Element indicating the name of the area within or adjacent to the town in which delivery address is.
+   * `street`: Element indicating road or street identifier or name 
+   * `town`: Element indicating the name of the populated place in which a delivery point is located, or near to or via which the delivery point is accessed. [Source: ISO19160-4]
+   * `unit`: An element representing a section of a building or organisation.Free-text description of the condition that leads to a surcharge beingapplied