gofs-v1/dev.sargunv.mobilitydata.gofs.v1

Package-level declarations

Types

data class BookingDetail(val serviceName: String? = null, val androidUri: Uri? = null, val iosUri: Uri? = null, val webUri: Url? = null, val phoneNumber: String? = null)

Details about how to book the on-demand service.

BookingRule

@Serializable

data class BookingRule(val fromZoneIds: List<String>, val toZoneIds: List<String>?, val bookingType: BookingType, val priorNoticeDurationMin: WholeMinutes? = null, val priorNoticeDurationMax: WholeMinutes? = null, val priorNoticeLastDay: Int? = null, val priorNoticeLastTime: ServiceTime? = null, val priorNoticeStartDay: Int? = null, val priorNoticeStartTime: ServiceTime? = null, val priorNoticeCalendarId: String? = null, val message: String? = null, val pickupMessage: String? = null, val dropOffMessage: String? = null, val phoneNumber: String? = null, val infoUrl: String? = null, val bookingUrl: String? = null)

A single booking rule defining how to book a ride for specific zones.

BookingRules

@Serializable

data class BookingRules(val bookingRules: List<BookingRule>) : GofsFeedData, List<BookingRule>

Defines rules about how to book a ride.

BookingType

@Serializable

@JvmInline

value class BookingType(val value: Int)

Indicates how far in advance booking can be made.

Brand

@Serializable

data class Brand(val brandId: String, val brandName: String, val brandColor: RgbColorTriplet? = null, val brandTextColor: RgbColorTriplet? = null)

A service brand with its visual identity.

Calendar

@Serializable

data class Calendar(val calendarId: String, val days: List<AbbreviatedWeekday>? = null, val startDate: BasicLocalDate, val endDate: BasicLocalDate, val exceptedDates: List<BasicLocalDate>? = null)

A calendar defining when on-demand services are available.

Calendars

@Serializable

data class Calendars(val calendars: List<Calendar>) : GofsFeedData, List<Calendar>

Defines the dates and days when on-demand services are available to the riders.

Fare

@Serializable

data class Fare(val fareId: String, val currency: CurrencyCode, val kilometer: List<FareEntry>? = null, val minute: List<FareEntry>? = null, val activeMinute: List<FareEntry>? = null, val idleMinute: List<FareEntry>? = null, val rider: List<FareEntry>? = null, val luggage: List<FareEntry>? = null)

A fare definition with pricing rules.

FareEntry

@Serializable

data class FareEntry(val interval: Double? = null, val start: Int? = null, val end: Int? = null, val amount: Double? = null)

A single fare entry defining pricing for a specific segment.

Fares

@Serializable

data class Fares(val fares: List<Fare>) : GofsFeedData, List<Fare>

Defines fare calculations for a system.

FeedType

@Serializable

@JvmInline

value class FeedType(val value: String)

The type of GOFS feed.

GofsFeedData

sealed interface GofsFeedData

Marker interface for GOFS feed data types.

GofsFeedResponse

@Serializable

data class GofsFeedResponse<T : GofsFeedData>(val lastUpdated: EpochSeconds, val ttl: WholeSeconds, val version: String, val data: T)

Common header structure for all GOFS feed responses.

GofsV1Client

class GofsV1Client : AutoCloseable

HTTP client for fetching GOFS v1 feeds.

OperatingRule

@Serializable

data class OperatingRule(val fromZoneId: String, val toZoneId: String, val startPickupWindow: ServiceTime? = null, val endPickupWindow: ServiceTime? = null, val endDropoffWindow: ServiceTime? = null, val calendars: List<String>, val brandId: String? = null, val vehicleTypeIds: List<String>, val fareId: String? = null)

A single operating rule defining when and where on-demand services are available.

OperatingRules

@Serializable

data class OperatingRules(val operatingRules: List<OperatingRule>) : GofsFeedData, List<OperatingRule>

Contains operating rules enabling on-demand services between zones or within the same zone.

RealtimeBooking

@Serializable

data class RealtimeBooking(val brandId: String, val waitTime: WholeSeconds, val travelTime: WholeSeconds? = null, val travelCost: Double? = null, val travelCostCurrency: CurrencyCode? = null, val bookingDetail: BookingDetail? = null)

Real-time booking information for a specific service brand.

RealtimeBookings

@Serializable

data class RealtimeBookings(val realtimeBookings: List<RealtimeBooking>) : GofsFeedData, List<RealtimeBooking>

Provides time/cost estimates and realtime booking information for specific locations.

Service

@Serializable

data class Service(val feeds: Map<FeedType, Url>) : Map<FeedType, Url>

A service containing feeds for a specific language.

ServiceBrands

@Serializable

data class ServiceBrands(val serviceBrands: List<Brand>) : GofsFeedData, List<Brand>

Defines the on-demand service brands available to the riders.

SystemInformation

@Serializable

data class SystemInformation(val language: LanguageCode, val timezone: TimeZone, val name: String, val shortName: String? = null, val operator: String? = null, val url: Url? = null, val subscribeUrl: Url? = null, val startDate: BasicLocalDate? = null, val phoneNumber: String? = null, val email: String? = null, val feedContactEmail: String? = null) : GofsFeedData

Defines the attributes of the on-demand service system.

SystemManifest

@JvmInline

@Serializable