Home » NOVA Parking » NOVA Parking Master Data

NOVA Parking Master Data (Package ch.voev.nova.parking.masterdata)

Types / Enumerations:


Types

EChargingServiceProvider

Type describes an e-charging provider that offers his services at a parking facility.


Properties / Associations

Name Type Multiplicity Constraints Description
swissPassPlusPartnerID SwissPassPlusPartnerID 1..1 SwissPass Plus partner id of the charging service provider.
supplierID SupplierID 1..1 Supplier ID of the e-charging service provider.
providerFacilityID String 1..1 ID for the parking facility as it was defined by the charging service provider.
preAuthorizationAmount MoneyAmount 1..1 Money amount that is reserved during the per authorization for a charging service.
energyContractID String 1..1 ID of the contract with the energy supplier.
energyContractSupplier String 1..1 Name of the energy supplier.
fssSupplierName String 0..1


Location

Type represents a postal address of a parking facility.


Properties / Associations

Name Type Multiplicity Constraints Description
street String 0..1 @Size(min=0, max=255)
postalCode String 0..1 @Size(min=0, max=15)
city String 1..1 @NotBlank
@Size(min=0, max=255)
countryCode CountryCode 1..1 Country code of the parking facility location.
geoPosition GeoPosition 0..1 Geo position of the parking facility.


OperatingHours

Type is used top define operationg hours of a parking facility.


Properties / Associations

Name Type Multiplicity Constraints Description
weekday Weekday 1..1
timePeriods TimePeriod 1..*


ParkingDataUnit


Type Details Details
Parent Class DataUnit


Properties / Associations

Name Type Multiplicity Constraints Description
parkingFacilityMasterData ParkingFacilityMasterData 1..1
parkingFacilityPricingModelMasterData ParkingFacilityPricingModelMasterData 1..1
parkingFacilityOperationModelMasterData ParkingFacilityOperationModelMasterData 1..1
parkingFacilities ParkingFacility 0..* derived
parkingFacilityPricingModels ParkingFacilityPricingModel 0..* derived
parkingFacilityOperationModels ParkingFacilityOperationModel 0..* derived
parkingFacilityServiceDescriptions ParkingFacilityServiceDescription 0..*


ParkingFacility

Type is used to provide master data about parking facilities.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
parkingFacilityID ParkingFacilityID 1..1 ID of the parking facility.
name String 1..1 Official name of the parking facility.
location Location 1..1 Information about where a parking facility is located.
spaceAmounts ParkingSpaceAmount 1..* List contains information about the amounts of different types of parking spaces.
note LocalizedString 0..1 Additional notes about a parking facility.
operationModel ParkingFacilityOperationModel 1..1 Operation model of the parking facility.
freeOfCharge boolean 1..1 Property describes if the parking facility is free of charge or not.

Please be aware that even though a parking facility may not be free of charge it is still possible that there are no pricing models defined (pricingModels is empty). This is the case when NOVA is not able to sell tickets for a certain parking facility.
pricingModels ParkingFacilityPricingModel 0..* Pricing models are used by NOVA to calculate the prices for a parking facility.

Please be aware that even though a parking facility may not be free of charge (freeOfCharge) it is still possible that there are no pricing models defined. This is the case when NOVA is not able to sell tickets for a certain parking facility.
nearbyStops Stop 0..* List of stops that are nearby to the parking facility.
novaLegacyParkingFacilityCode java.lang.Integer 0..1 @Positive
 Internal NOVA code for mapping from official ParkingFacilityID.
paymentCommissionRateParkingTicket java.math.BigDecimal 0..1 Payment commission rate for parking tickets.
paymentCommissionRateParkingSubscription java.math.BigDecimal 0..1 Payment commission rate for parking subscriptions.
owner Organization 0..1 Owner of the parking facility.
authorizedChannels Channel 0..* List with channels that are allowed to offer and sell tickets for the parking facility. If the list is empty then it means that there is no channel that is allowed to sell tickets for that parking facility.
externalParkingAuthorization ExternalParkingAuthorization 1..1 Definition of an external authorization that needs to be called in order to check if a parcing facility can bo offered to a certain customer.
eChargingServiceProviders EChargingServiceProvider 0..* List o providers that offer e-charging services at a parking facility.
parkingFacilityType ParkingFacilityType 1..1 Type of the parking facility.
vehicleCategories ParkingVehicleCategory 1..* derived List with all vehicle categories that can be used on a parking facility of this type.
availableServices ParkingFacilityServiceDescription 0..* List of services that are available at this parking facility.
allowedAuthorizationControlSolutions ParkingAuthorizationControlSolution 0..* Solutions that are possible to be used to control if there is a valid parking authorization.
singleTicketRevenueDistributionKey DistributionKey 0..1
subscriptionRevenueDistributionKey DistributionKey 0..1
alternativeFacilities ParkingFacility 0..* Alternative parking facilities that might be used as fallback if this parking facility is occupied.


ParkingFacilityMasterData


Type Details Details
Parent Class EntityMasterData


Properties / Associations

Name Type Multiplicity Constraints Description
parkingFacilities ParkingFacility 0..*


ParkingFacilityOperationModel

Type is used to provide master data about the operation model of a parking facility.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
name String 1..1
chargedOperatingHours OperatingHours 1..* List contains all operating hours of a parking facility.


ParkingFacilityOperationModelMasterData


Type Details Details
Parent Class EntityMasterData


Properties / Associations

Name Type Multiplicity Constraints Description
parkingFacilityOperationModels ParkingFacilityOperationModel 0..*


ParkingFacilityPricingModel


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
name String 1..1
timeUnit TimeUnit 1..1 Time unit that is used for price calculation.
maxPrice Price 1..1
maxPriceTimeUnit TimeUnit 1..1
minDuration Duration 0..1
maxDuration Duration 1..1
chargingPeriodInterval Duration 0..1
priceIncrements PriceIncrement 1..* Price increments that are used for price calculation.
selectableIncrement Duration 0..1
publicTransportSeasonTicketRequired boolean 1..1 Property defines if for this pricing model a valid public transport season ticket is required.
product Product 1..1 NOVA product that is used when selling parking tickets / subscriptions.


ParkingFacilityPricingModelMasterData


Type Details Details
Parent Class EntityMasterData


Properties / Associations

Name Type Multiplicity Constraints Description
parkingFacilityPricingModels ParkingFacilityPricingModel 0..*


ParkingFacilityServiceDescription

Type is used to provide a description about the services that are available at a parking facility.


Type Details Details
Parent Class EntityVersion


Properties / Associations

Name Type Multiplicity Constraints Description
description LocalizedString 1..1 Description about a service that might be offered at a parking facility.


ParkingSpaceAmount

Type represents the amount of space of one type that exist on a parking.


Properties / Associations

Name Type Multiplicity Constraints Description
spaceType ParkingSpaceType 1..1
amount int 1..1 @PositiveOrZero
 Amount of parking space of this space type.


PriceIncrement


Properties / Associations

Name Type Multiplicity Constraints Description
start int 1..1 @PositiveOrZero
 Start of the price level. Its end is defined by the beginning of the next level.
pricePerUnit Price 1..1 Price per unit. The type unit is defined by the price model in general.


SupplierID

Type is used to represent the ID of any kind of supplier as it is used in the finance domain.


Properties / Associations

Name Type Multiplicity Constraints Description
id String 1..1


SwissPassPlusPartnerID


Properties / Associations

Name Type Multiplicity Constraints Description
id String 1..1 @Size(min=8, max=8)



Enumerations

ExternalParkingAuthorization

In cases of parking facilities sometimes it is required that an external services grants an authorization before it can be offered / sold. The supported types of authorizations are described by this enumeration.

Please be aware that this type is a so called extensible enum. This means that additional literals might be added in the future and that this is considered to be a non-breaking / SemVer compliant change.

Literals

Name Description
NO_AUTHORIZATION_REQUIRED Literal for case that no external authorization is required.
SUBSCRIPTION_ONLY_WITH_APPROVAL_OF_VAUD Literal for case that authorization by the administration of canton of Vaud is required.
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.

ParkingAuthorizationControlSolution

Enumeration defines the solution that might be used to check parking authorizations

Literals

Name Description
SBB_PRAIL_CONTROL_APP P+Rail Control App of SBB
DIGITAL_PARKING Parkingcheck app by digitalparking
ABRAXAS "Kontroll und Bussen" app by Abraxas
OM_PERMISSION_CHECK PermissonCheck app by OM
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.

ParkingFacilityType

Enumeration is used to describe the type of a parking facility.

Please be aware that this type is a so called extensible enum. This means that additional literals might be added in the future and that this is considered to be a non-breaking / SemVer compliant change.

Literals

Name Description
PARK_AND_RAIL Literal for P+Rail parking facility. These parking facilities are always located close to a station and are owned by public transport companies. They are always marked with an P+Rail icon.

Usually there tickets are offered on an hourly, daily, monthly and yearly basis.
CAR_PARKING Literal for car parkings that do not belong to the P+Rail category. These parking facilities can also be owned by non public transport companies.

The kind of tickets that are available on these parkings depends on the specific parking.
BIKE_STATION A bike station (aka Velostation) is a rather comfortable parking for bikes with restricted access and subject to charge. It is either served or has self-service access.

Typical bike stations are located at all major stations in Switzerland. Its main characteristics is that it is rather large and that access is restricted. In most cases it is monitored by video and / or security staff.

Many bike stations also offer additional services like repairs, air pumps etc.
BIKE_PARKING A bike parking is a rather simple parking for bikes. It is not roofed and has simple bike holders which might be two-storied.

It's not possible to park trailers, special bikes, scooters etc.
BIKE_PARKING_ROOFED A bike parking is a rather simple parking for bikes. It is roofed and has simple bike holders which might be two-storied.

It's not possible to park trailers, special bikes, scooters etc.
NON_CAR_PARKING_SPACES Non-roofed parking spaces at ground level. There are no bike holders or anything like that.

It can also be used for trailers, special bikes, scooters and motorcycles.
NON_CAR_PARKING_SPACES_ROOFED Roofed parking spaces at ground level. There are no bike holders or anything like that.

It can also be used for trailers, special bikes, scooters and motorcycles.
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.

ParkingSpaceType

Enumeration is used to define to different types of parking spaces.

Please be aware that this type is a so called extensible enum. This means that additional literals might be added in the future and that this is considered to be a non-breaking / SemVer compliant change.

Literals

Name Description
STANDARD_SPACE
RESERVABLE_SPACE
SPACE_WITH_CHARGER
DISABLED_PARKING_SPACE
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.

ParkingVehicleCategory

Enumeration is used to categorize parking facilities.

Please be aware that this type is a so called extensible enum. This means that additional literals might be added in the future and that this is considered to be a non-breaking / SemVer compliant change.

Literals

Name Description
CAR Literal is used for cars.
BIKE Literal is used for bikes.
BIKE_TRAILER Literal is used for bike trailers.
SPECIAL_BIKE Literal is used for special bike.
SCOOTER Literal is used for (motorized) scooters.
MOTORCYCLE Literal is used for motorcycles.
UNKNOWN Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice.