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

OperatingRule

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)(source)

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

Constructors

OperatingRule

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

Properties

brandId

@SerialName(value = "brand_id")

val brandId: String?

ID from a service brand defined in service_brands.json. If this field is not provided, the operating rule applies to every service brand defined in service_brands.json.

calendars

val calendars: List<String>

Array of calendar IDs from calendars.json defining the dates and days when the pickup and drop off occur.

endDropoffWindow

@SerialName(value = "end_dropoff_window")

val endDropoffWindow: ServiceTime?

Time at which the drop off stops being available in to_zone_id defined in this array. Some services differ the end of the pickup time and the end of the drop off time (e.g.: The pickup time ends at 10PM in the origin zone but it is still possible to be dropped off in the destination zone until 10:30PM). If end_dropoff_window is provided, start_pickup_window must be provided.

endPickupWindow

@SerialName(value = "end_pickup_window")

val endPickupWindow: ServiceTime?

Time at which the pickup stops being available in from_zone_id defined in this array. If end_pickup_window is provided, start_pickup_window must be provided.

fareId

@SerialName(value = "fare_id")

val fareId: String?

Unique identifier of a fare. Used to determine the price of the on-demand service.

fromZoneId

@SerialName(value = "from_zone_id")

val fromZoneId: String

ID from a zone defined in zones.json representing the boarding zone for the current rule.

startPickupWindow

@SerialName(value = "start_pickup_window")

val startPickupWindow: ServiceTime?

Time at which the pickup starts being available in from_zone_id defined in this array. If start_pickup_window is provided, either end_pickup_window or end_dropoff_window must also be provided.

toZoneId

@SerialName(value = "to_zone_id")

val toZoneId: String

ID from a zone defined in zones.json representing the alighting zone for the current rule. from_zone_id and to_zone_id may reference the same zone.

vehicleTypeIds

@SerialName(value = "vehicle_type_id")

val vehicleTypeIds: List<String>

Array of vehicle types used for delivering the on-demand service.