HapiMessage

data class HapiMessage(id: String, externalId: String?, act: Boolean, head: String, lead: String?, text: String, customText: String?, tckr: String?, company: String?, category: String?, priority: Int, products: Int?, icon: String?, routeIdxFrom: Int?, routeIdxTo: Int?, sTime: LocalTime?, sDate: LocalDate?, eTime: LocalTime?, eDate: LocalDate?, altStart: String?, altEnd: String?, modTime: LocalTime?, modDate: LocalDate?, affectedProduct: List<HapiProduct>, affectedJourney: List<HapiJourney>, edge: List<HapiMessage.Edge>, region: List<HapiMessage.Region>, affectedStops: List<HapiAffectedStop>, validFromStop: HapiStop?, validToStop: HapiStop?, tags: List<String>, channel: List<HapiMessage.Channel>, messageCategory: List<HapiMessage.Category>, messageText: List<HapiMessage.Text>, Note: List<HapiNote>, message: List<HapiMessage>)

Types

Category

data class Category(id: Int, name: String?)

Message category having an ID and optional a name.

Channel

data class Channel(name: String?, url: List<String>, validFromTime: LocalTime, validFromDate: LocalDate, validToTime: LocalTime, validToDate: LocalDate)

Edge

data class Edge(polyline: List<HapiPolyline>, polylineGroup: List<HapiPolylineGroup>, iconCoordinate: HapiCoord?, messageRef: List<Int>, direction: Int)

Region

data class Region(polyline: List<HapiPolyline>, polylineGroup: List<HapiPolylineGroup>, iconCoordinate: HapiCoord?, messageRef: List<Int>)

Text

data class Text(tag: List<String>, text: List<String>)

Properties

act

val act: Boolean = true

If message is active, value is true.

affectedJourney

val affectedJourney: List<HapiJourney>

Journeys affected by this message

affectedProduct

val affectedProduct: List<HapiProduct>

Products affected by this message

affectedStops

val affectedStops: List<HapiAffectedStop>

Stops affected by this message

altEnd

val altEnd: String?

Descriptive text for end of event period.

altStart

val altStart: String?

Descriptive text for start of event period.

category

val category: String?

Deprecated. See Message/MessageCategory. For sanity reason, id of first MessageCategory ist filled here.

channel

val channel: List<HapiMessage.Channel>

List of publication channels along with its validity and optional URLs.

company

val company: String?

Company whom created this message.

customText

val customText: String?

Custom text

eDate

val eDate: LocalDate?

Event period ending date in format YYYY-MM-DD.

edge

val edge: List<HapiMessage.Edge>

Edges affected by this message

eTime

val eTime: LocalTime?

Event period ending time in format hh:mm:ss

externalId

val externalId: String?

External ID of the message if based on an external system.

head

val head: String

Heading of message.

icon

val icon: String?

id

lead

val lead: String?

Preamble of message.

message

val message: List<HapiMessage>

Child messages.

messageCategory

val messageCategory: List<HapiMessage.Category>

List of message categories with its ID and optional localized name.

messageText

val messageText: List<HapiMessage.Text>

List of messages texts with its tags and localized text fragments.

modDate

val modDate: LocalDate?

Message was last modified at date in format YYYY-MM-DD.

modTime

val modTime: LocalTime?

Message was last modified at time in format hh:mm:ss

Note

val Note: List<HapiNote>

List of notes to be displayed for this message.

priority

val priority: Int

Priority of the message.

products

val products: Int?

This value specifies the products affected by this message.

region

val region: List<HapiMessage.Region>

Regions affected by this message

routeIdxFrom

val routeIdxFrom: Int?

First stop/station where this message is valid. See the Stops list in the JourneyDetail response for this leg to get more details about this stop/station.

routeIdxTo

val routeIdxTo: Int?

Last stop/station where this message is valid. See the Stops list in the JourneyDetail response for this leg to get more details about this stop/station.

sDate

val sDate: LocalDate?

Event period beginning date in format YYYY-MM-DD.

sTime

val sTime: LocalTime?

Event period beginning time in format hh:mm:ss

tags

val tags: List<String>

List of tags this message is tagged with.

tckr

val tckr: String?

Deprecated. Message text for ticker display.

text

val text: String

Message text.

validFromStop

val validFromStop: HapiStop?

Message is valid from this stop.

validToStop

val validToStop: HapiStop?

Message is valid until this stop.