Home » NOVA Common » NOVA Common Data Types
ch.voev.nova.common.datatypes
)Types / Enumerations:
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
name | String | 1..1 | ||
groupID | String | 0..1 | ||
artifactID | String | 0..1 | ||
versionInfo | VersionInfo | 1..1 |
Type represents the business log for a request. Besides the log entries it also has information about the request itself.
Type Details | Details |
---|---|
Alias | Fachlog |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
novaClientCode | NOVAClientCode | 1..1 | Identification of the NOVA client that sent a request. | |
organizationCode | OrganizationCode | 1..1 | Identification for the organization that sent a request. | |
traceParent | String | 0..1 | Trace parent header as it was part of the request. The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context, https://www.w3.org/TR/trace-context). | |
dateShift | String | 0..1 | Date shift header as it was part of the request. Header field can be used to modify the date part of the request time stamp. It can either be defined as an absolute date in format "YYYY-MM-DD" or as an relative shift using '+' / '-' in combination with a shift value as absolute number for the amount of days that should be shifted (e.g. "-7" or "+2" days). Date shift is only supported on non productive environments. | |
timeShift | String | 0..1 | Time shift header as it was part of the request. Header field can be used to modify the time part of the request time stamp. It can either be defined as an absolute time in format HH:mm:ss or as an relative shift using '+' / '-' in combination with a shift value as absolute number for the amount of minutes that should be shifted (e.g. "-31" or "+120" minutes). Time shift is only supported on non productive environments. | |
logEntries | BusinessLogEntry | 0..* | List with all log entries that belong to the business log. The entries are ordered according to the time when they occurred. |
Type represents a business log entry.
Business log entries are provided to allow an analysis of the response as it was returned by NOVA. This is especially helpful in areas were rather complex business logic is executed in order to produce responses.
Target group of the business log are e.g. integrators, testers, data managers, POs etc. that want to understand more in detail why a specific response was returned.
NOVA's business log is not intended to be a replacement for standard logging as it is usually done by developers.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
logEntryCode | LogEntryCode | 1..1 | Code of the log entry. | |
timestamp | java.time.OffsetDateTime | 1..1 | Timestamp when the log entry was created. | |
summary | String | 1..1 | Summary of the log entry. The summary is expected to be rather short and should provide an overview about what the entry is about. As the summary is expected to be rather short, it is not supposed to contain markdown markup for formatting. Its strongly recommended to always provide details in English. | |
sourceDomain | DomainType | 1..1 | Domain by which a business log entry was created. | |
logEntryType | LogEntryType | 1..1 | Type of the log entry. | |
details | String | 1..1 | Detailed information that should help for an analysis. It is possible that the details of a log entry are rather long. In order to support a better readability it is explicitly allowed to format the details of a log entry using markdown markups. Its strongly recommended to always provide details in English. |
Type can be used a a container for debug info objects, also recursively.
Type Details | Details |
---|---|
Parent Class | DebugInfo |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
details | DebugInfo | 0..* | Loist with all debug info objects that are aggregated by this object. |
Data type represents an ISO 3166 alpha-2 country code. These codes always consist of two capital letters like "CH" or "FR"
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
code | String | 1..1 | @Size(min=2, max=2) | ISO 3166 alpha-2 country code. These codes always consist of two capital letters like "CH" or "FR". |
Type defines a temporal period using dates. The period that is defined by this class includes the start end and date.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
from | java.time.LocalDate | 1..1 | Start date when the period begins. Start is included within the period. | |
through | java.time.LocalDate | 1..1 | Date when the period ends. The end is included within the period. |
Type defines a temporal period using date times. The period that is defined by this class includes the start but not the end date time.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
from | java.time.OffsetDateTime | 1..1 | Start date time when the period begins. Start is included within the period. | |
until | java.time.OffsetDateTime | 1..1 | Date time when the period ends. The end is not included within the period. |
Type represents debug information that can be added to objects (if they support it).
Type Details | Details |
---|---|
Abstract | true |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
type | String | 1..1 |
Unfortunately, OpenAPI 3.x does not support decimal values that require a higher precision (like BigDecimal e.g. in Java). Thus we have to define that type on our own here.
Similar to other implementations we work here with an unscaled value and a scale. This means that a DecimalNumber with unscaledValue = 47110815 and scale = 4 represents the decimal number "4711.0815".
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
unscaledValue | long | 1..1 | Unscaled value as part of our decimal number. | |
scale | int | 1..1 | Scale part of the decimal value. |
Type is the base class for all domain specific extensions.
Domain extension is a generic mechanism on NOVA side that allows to add domain specific extensions in an API without introducing matching dependencies. Initially this mechanism was designed for the generic checkout process of NOVA. However, as it is not checkout specific it might also be used in other areas.
Type Details | Details |
---|---|
Abstract | true |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
domainExtensionType | DomainExtensionType | 1..1 |
Type represents one or more values of a domain extension index property.
Domain extension index properties are properties of a domain extension that can be used to create an index for domain extensions.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
domainExtensionIndexProperty | DomainExtensionIndexProperty | 1..1 | Domain extension index property to which the values of this object belong to. | |
actualValues | String | 0..* | Actual values of the domain extension index property. |
Type can be used to define a query for domain extension with specific values.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
criteria | PropertyCriteria | 1..* | List of criteria that all have to be fulfilled. |
Type describes a reference of an external system / application / component on a entity of a other domain.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
systemID | SystemID | 1..1 | ID of the system that references an entity. The combination of systemID and externalReferenceID must be unique. | |
externalEntityID | ExternalReferenceID | 1..1 | External ID of the source object that is referencing an entity. The ID has to be unique at least within the scope of the system that registered the reference. The combination of systemID and externalReferenceID must be unique. | |
novaClientCode | NOVAClientCode | 1..1 | Code of the NOVA Client which created the object reference and to which the external entity belongs to. | |
organizationCode | OrganizationCode | 1..1 | Code of the organization that created the object reference and to which the external entity belongs to. |
Type represents a duration.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
value | int | 1..1 | @PositiveOrZero | Length of the duration using the set time unit. |
unit | TimeUnit | 1..1 | Time unit in which the duration is defined. |
The HTTP ETag of a resource, usually stored in AWS S3.
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
value | String | 1..1 |
Type is intended to be used when ever there should be the possibility that NOVA Clients can pass an external reference to requests.
One case where this is usually needed is that clients can easily map responses to requests.
From a NOVA perspective there are no constraints to this reference ID besides its maximum length. It is not expected that it is unique or anything like that.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
id | String | 1..1 | @Size(min=0, max=64) |
Type describes a geo position using WGS84 coordinates.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
longitude | java.math.BigDecimal | 1..1 | @Min(minValue=-180) @Max(maxValue=180) | Longitude from Greenwich Meridian. -180 (West) to +180 (East). |
latitude | java.math.BigDecimal | 1..1 | @Min(minValue=-90) @Max(maxValue=90) | Latitude from equator. -90 (South) to +90 (North). |
Type is intended to be used as parameter for all NOVA REST operations that require idempotency.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
idempotencyKey | IdempotencyKey | 1..1 | Idempotency keys are used to ensure that the same request is executed only once. It's in the responsibility of the NOVA client that an idempotency key is unique within the scope of the client. Idempotency will only be checked per operation and is not ensured for multiple calls to different methods / resources. For further details please also check NOVA's definition about idempotency: https://confluence.sbb.ch/display/NOVA/NOVA+REST+API+Guidelines#NOVARESTAPIGuidelines-Idempotency |
Idempotency keys are used to ensure that the same request is executed only once. It's in the responsibility of the NOVA client that an idempotency key is unique within the scope of the client. Idempotency will only be checked per operation and is not ensured for multiple calls to different methods / resources.
For further details please also check NOVA's definition about idempotency: https://confluence.sbb.ch/display/NOVA/NOVA+REST+API+Guidelines#NOVARESTAPIGuidelines-Idempotency
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
key | String | 1..1 |
Data type represents an ISO-639-1 language code.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
code | String | 1..1 | @Size(min=1, max=2) | ISO-639-1 language code e.g. "de" for German. Can be "*" when used in the NOVAContext header, to indicate that all languages should be included in the response. |
Type defines a temporal period using local times. The period that is defined by this class includes the start but not the end time.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
from | java.time.LocalTime | 1..1 | Start time when the period begins. Start is included within the period. | |
until | java.time.LocalTime | 1..1 | Time when the period ends. The end is not included within the period. |
Type defines a so called localized string. Localized string whenever a language dependent strings are needed to be used e.g. for names of products. Localized strings always have a default text and might have localizations in addition.
In general NOVA supports the languages German, French, Italian and English. However it is not guaranteed that localized string always have localizations for all those languages.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
defaultText | String | 1..1 | @NotEmpty @Size(min=0, max=4000) | Default text that should be used when ever no matching localization is available. |
localizations | TextLocalization | 0..* | List with all localizations that are available for this localized string. |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
defaultURL | URL | 1..1 | ||
localizations | URLLocalization | 0..* |
Code can be used to identity a log entry. All same log entries will use the same code.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
code | int | 1..1 | Code of a debug log entry. |
Type represents an amount of money as it is used for prices. This class internally represents a money amount in its currency subunit.
Please be aware of the following things: * This type is not intended to be used for money amounts that require a high precision (e.g. NOVA revenues), due to limitations of OpenAPI in defining the precision of decimal numbers.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
unscaledAmount | int | 1..1 | Unscaled amount of money using the defined currency subunit of its currency. Example: 32.10 CHF will have an unscaledAmount of 3210 centime (aka Rappen) | |
currency | Currency | 1..1 | Currency of the money amount. |
Data type represents the code of a NOVA client e.g. "46" for SBB Mobile App. A NOVA client can be a channel as well as another systems that does not sell tickets.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
code | Integer | 1..1 | @Max(maxValue=99999) @Positive | NOVA channel code like "46" for SBB Mobile App. |
Class represents a generic context for request to NOVA. It contains context information that are present for any kind of requests to NOVA.
The class may be extended to add additional information for specific services.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
traceParent | String | 0..1 | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context, https://www.w3.org/TR/trace-context). | |
traceState | String | 0..1 | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
conversationID | String | 0..1 | Conversation id is used to group together a sequence of REST calls to NOVA. All requests that belong to the same business process are supposed to have the same conversation id. | |
acceptLanguage | LanguageCode | 0..1 | Preferred language of the requesting client. Attribute can be filled according to logic of HTTP Header field as defined on Accept-Language. This explicitly includes weighting of languages (e.g. "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5"). However please be aware that NOVA in general only supports the languages "de", "fr", "it" and "en". Even though the parameter is optional it's strongly recommended to provide it in requests, if not default language will be used. Please be aware that NOVA's default language is not explicitly defined and may change over time without prior notice. | |
dateShift | String | 0..1 | Header field can be used to modify the date part of the request time stamp. It can either be defined as an absolute date in format "YYYY-MM-DD" or as an relative shift using '+' / '-' in combination with a shift value as absolute number for the amount of days that should be shifted (e.g. "-7" or "+2" days). Date shift is only supported on non productive environments. | |
timeShift | String | 0..1 | Header field can be used to modify the time part of the request time stamp. It can either be defined as an absolute time in format HH:mm:ss or as an relative shift using '+' / '-' in combination with a shift value as absolute number for the amount of minutes that should be shifted (e.g. "-31" or "+120" minutes). Time shift is only supported on non productive environments. | |
organizationCode | OrganizationCode | 0..1 | Identification for the organization (aka as LV or Leistungsvermittler in most cases in NOVA 14) that sends a request. In the future, this information will be resolved from the authorization token. This means that NOVA will overwrite the value of this header if it was provided by a client. | |
novaClientCode | NOVAClientCode | 0..1 | Identification of the NOVA client that sends a request (aka Kanal / Channel in NOVA 14). In the future, this information will be resolved from the authorization token. This means that NOVA will overwrite the value of this header if it was provided by a client. | |
novaSubject | String | 0..1 | Identification of the NOVA subject (=primary TKID) that sends a request. This header allows to artificially restrict the current request, for tokens that would otherwise have unrestricted access to all NOVA subjects. For most token types, this information will be resolved from the authorization token (from the nova_sub claim) and this header is ignored. This header is only supported on non productive environments. | |
enableDebugInfo | boolean | 0..1 | Header field can be used to enable debug info in responses on request level. Using the header additional debug info will be returned as part of NOVA responses. Depending on the environment and other criteria it might happen that even though this header is set, no debug info will be returned. The reason for that is that producing debug info is a very expensive / chatty thing and might overload the application if it is used too intensively. | |
clientApiVersion | String | 0..1 | The NOVA API version of the REST client / user agent sending the request. Endpoints of the NOVA platform may use this to adjust their behavior (ex. relax validation, warn about deprecated versions, ..). Since 3.3.0. Will become mandatory in at 2025-11-24. | |
businessLogEnabled | boolean | 0..1 | Header field can be used to enable business log in responses on request level. Using the header additional business log will be returned as part of NOVA responses (if supported by the called endpoint). Depending on the environment and other criteria it might happen that even though this header is set, no business log will be returned. The reason for that is that producing business log is a very expensive / chatty thing and might overload the application if it is used too intensively. |
Represents a numeric range with an inclusive minimum and maximum value. Both can be defined optionally to allow for unbounded ranges.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
min | java.lang.Integer | 0..1 | The minimum inclusive value of the range. May be left optional to represent no lower boundary. | |
max | java.lang.Integer | 0..1 | The maximum inclusive value of the range. May be left optional to represent no upper boundary. |
Generic type to build a change log for a business object.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
objectID | I | 1..1 | ID of the object whose changes are described by this log entry. | |
data | D | 1..1 | Business data (payload) describing the changes of the object from a business perspective. | |
eventTimestamp | java.time.OffsetDateTime | 1..1 | Timestamp when the change log entry was created. This might not be the same point in time when the change becomes active from a business perspective. | |
effectiveChangeTimestamp | java.time.OffsetDateTime | 1..1 | Timestamp when the represented object changes its state effectively from a business perspective. Example: * When a contract is terminated the eventTimestamp is the actual time when the termination was received by the system. The effectiveChangeTimestamp however will be the one when the contract will be terminated and can not be used any more. | |
effectiveState | S | 1..1 | Effective state of the object. The object has this state at effectiveChangeTimestamp . | |
event | T | 1..1 | Event that triggered the change of the object. | |
actor | UserReferenceID | 1..1 | Actor that caused the change of the object. | |
clientInfo | C | 1..1 | Additional info about the NOVA client through which the object change was caused. |
Class can be used to use debug info about an object with an unique ID.
Type Details | Details |
---|---|
Parent Class | DebugInfo |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
name | String | 1..1 | Name of the property about which the debug info is. | |
objectID | String | 1..1 | ID of the object about which the debug info is. |
Generic type for all NOVA responses that support paging.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
page | int | 1..1 | Index of the page that was be returned. | |
size | int | 1..1 | Size of the page that was returned. This value shows the requested page size. It might happen that in reality less objects are returned. In this case property hasMore will be false . | |
hasMore | boolean | 1..1 | Attribute is set to "true" in case that there are more pages with data available. | |
objects | T | 0..* |
Type can be used by REST operations that want to offer paging of their responses.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
page | int | 0..1 | Index of the page that should be returned. First index starts with 0. | |
size | int | 0..1 | Size of the page that should be returned. |
Type can be used as debug info for a single property.
Type Details | Details |
---|---|
Parent Class | DebugInfo |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
name | String | 1..1 | Name of the property about which the debug info is. | |
value | String | 1..1 | Debug info value for the property. |
Type defines a query criteria for a single domain extension property.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
expectedValues | String | 1..* | Expected values of the domain extension property. If multiple values are defined then they are will be conjuncted as a logical OR. | |
domainExtensionIndexProperty | DomainExtensionIndexProperty | 1..1 | Domain extension index property on which the criteria defined by this object will be applied on. |
Type Details | Details |
---|---|
Parent Class | DomainExtension |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
rawValue | String | 1..1 |
Type is used to identify a system. A system can be a NOVA client as well as any other system.
In order to avoid naming collisions the following naming rules pattern is expected to be used: company code
::application code
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
id | String | 1..1 |
Objects of this type represent one concrete localization of a string.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
text | String | 1..1 | @NotEmpty @Size(min=0, max=4000) | String using the defined language. |
language | LanguageCode | 1..1 | Language in which the text of this object is. |
Type defines a temporal period using times. The period that is defined by this class includes the start but not the end time.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
from | java.time.OffsetTime | 1..1 | Start time when the period begins. Start is included within the period. | |
until | java.time.OffsetTime | 1..1 | Time when the period ends. The end is not included within the period. |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
url | String | 1..1 | @NotBlank @Size(min=0, max=2048) |
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
url | URL | 1..1 | ||
language | LanguageCode | 1..1 |
Type is used to represent information about a user without actually storing any data that is GDPR relevant. A user can be a customer as well as a sales agent.
In any case the user information is taken from the authentication token of the NOVA request.
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
id | String | 1..1 | @Size(min=0, max=512) | Reference ID representing the user. What is taken as ID depends on the IdP that was used to identify a user. |
Type describes a version of an artifact (API, application etc.)
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
version | String | 1..1 | Version number of the artifact. |
Type can be used to provide version information about an object e.g. to avoid dirty writes (aka optimistic locking) or to detect outdated data.
Important: - This type is not connected at all with versioning of NOVA Master Data
Properties / Associations
Name | Type | Multiplicity | Constraints | Description |
---|---|---|---|---|
version | int | 1..1 | @PositiveOrZero |
Enumeration describes the different types of channel that are distinguished by NOVA.
Name | Description |
---|---|
ONLINE | Channels like mobile apps or web shops. |
TICKET_VENDING_MACHINE | Any kind of ticket vending machines. |
TICKET_COUNTER | Server point of sale can be an agent at a station or a bus driver. |
BATCH | Channel that operates in a batch mode. |
POST_PRICING | Channel that operates in post pricing mode. (currently not used) |
Enumeration defines all the currencies that are known in the NOVA ecosystem. Please be aware that in this list also EUR is present even though it is supported only in very rare cases.
Name | Description |
---|---|
CHF | Swiss Francs is currently the one and only currency that is supported by NOVA. |
EUR | Currently currency EUR is not supported by NOVA. This literal is only present to avoid breaking changes in the future, but most likely EUR will never be supported. This is also the reason why this literal is marked as deprecated. |
Enumeration can be used to express constraints concerning dates, date times or times.
Name | Description |
---|---|
FUTURE | |
FUTURE_OR_PRESENT | |
PAST | |
PAST_OR_PRESENT |
Enumeration defines all the properties that are available as properties for a domain extension index.
A domain extension index property is always related to exactly one domain extension.
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.
Name | Description |
---|---|
CUSTOMER_IDS | Literal representing the customer IDs within the domain extension query index. |
TICKET_TYPE | Literal representing the ticket type within the domain extension query index. |
TRAVEL_AUTHORIZATION_ID | Literal representing the travel authorization ID within the domain extension query index. |
LICENSE_PLATES | Literal representing a license plate within the domain extension query index. |
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Enumeration defines all domain extensions that are available on NOVA.
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.
Name | Description |
---|---|
RAW | Literal for raw representation of a domain extension. This literal is only used for technical reasons and must not be referenced in business code. |
MOCK | Literal for mock domain extension. This extension is only used for test purposes. |
COUPON | Literal for coupon domain extension. |
EXTERNAL_RESTRICTION | Literal for external restriction domain extension. |
QUOTA | Literal for quota domain extension. |
INVENTORY | Literal for inventory domain extension. |
PUBLIC_TRANSPORT | Literal for public transport domain extension. |
SWISSPASS | Literal for SwissPass domain extension. |
CUSTOMER_LINK | Literal for customer link domain extension. |
PERSONALIZATION | Literal for customer link domain extension. |
PARKING | Literal for parking domain extension. |
PARKING_PROMO_CODE | Literal for P+Rail promo code domain extension. |
PARKING_VAUD_QUOTA_SERVICE | Literal for domain extension for parking quota service of canton of Vaud. |
ZONE_RESTRICTION_CHECK | Literal for domain extension that is used for zone restriction check. |
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Enumeration describes the visibility of NOVA domain extensions. For every domain extension a visibility is defined.
As the name implies, the visibility controls who is allowed to see a domain extension.
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.
Name | Description |
---|---|
PUBLIC | Literal for domain extensions that are visible without any limitation. |
CONFIDENTIAL | Literal for domain extensions that are confidential. Confidential means that this information is only visible outside NOVA if a client / consumer as a meaningful reason why access is needed. This category is also visible internally. |
INTERNAL | Literal for domain extensions that are only visible for NOVA internal components. |
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Enumeration defines all the domains that somehow belong to NOVA or are the owner of types used by NOVA.
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.
Name | Description |
---|---|
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Type of a business log entry.
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.
Name | Description |
---|---|
INFO | Type is used for all kinds of information that should be added to business log. |
EXCEPTION | Type is used for log entries that describe (business) exceptions |
SUMMARY | Type is used for entries that summarize the result of an activity or service call. |
VALIDATION_RESULT | Type is used for entries that describe the result of a validation. |
REQUEST | Type is used for log entries that describe a request to a service (public or internal) |
RESPONSE | Type is used for log entries that describe a response from a service (public or internal) |
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Enumeration for logical operators
Name | Description |
---|---|
AND | AND operator |
OR | OR operator |
XOR | XOR operator |
Enumeration defines the maturity levels that are used for NOVA APIs.
Name | Description |
---|---|
UNKNOWN | Please be aware that this enum is an extensible enum. This means that new literals can be introduced without prior notice. |
Enumeration represents time units.
Name | Description |
---|---|
MINUTES | |
HOURS | |
DAYS | |
WEEKS | |
MONTHS | |
YEARS |
Enum defines all days of a week.
Name | Description |
---|---|
MONDAY | |
TUESDAY | |
WEDNESDAY | |
THURSDAY | |
FRIDAY | |
SATURDAY | |
SUNDAY |