models

package
v0.0.0-...-6ca850d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2020 License: MIT Imports: 6 Imported by: 0

README

client

import "github.com/ronny/ptvapi/client"

Overview

Imported Packages

Index

Package files

doc.go ptv_timetable_api_v3_client.go

Constants

const (
    // DefaultHost is the default Host
    // found in Meta (info) section of spec file
    DefaultHost string = "timetableapi.ptv.vic.gov.au"
    // DefaultBasePath is the default BasePath
    // found in Meta (info) section of spec file
    DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default PTV timetable API v3 HTTP client.

var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

type PTVTimetableAPIV3

type PTVTimetableAPIV3 struct {
    Departures *departures.Client

    Directions *directions.Client

    Disruptions *disruptions.Client

    Outlets *outlets.Client

    Patterns *patterns.Client

    RouteTypes *route_types.Client

    Routes *routes.Client

    Runs *runs.Client

    Search *search.Client

    Stops *stops.Client

    Transport runtime.ClientTransport
}

PTVTimetableAPIV3 is a client for PTV timetable API v3

func New
func New(transport runtime.ClientTransport, formats strfmt.Registry) *PTVTimetableAPIV3

New creates a new PTV timetable API v3 client

func NewHTTPClient
func NewHTTPClient(formats strfmt.Registry) *PTVTimetableAPIV3

NewHTTPClient creates a new PTV timetable API v3 HTTP client.

func NewHTTPClientWithConfig
func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *PTVTimetableAPIV3

NewHTTPClientWithConfig creates a new PTV timetable API v3 HTTP client, using a customizable transport config.

func (*PTVTimetableAPIV3) SetTransport
func (c *PTVTimetableAPIV3) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
    Host     string
    BasePath string
    Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig
func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath
func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost
func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes
func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.


Generated by godoc2ghmd

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type V2Object

type V2Object interface{}

V2Object v2 object swagger:model V2.Object

type V3BulkDeparturesRequest

type V3BulkDeparturesRequest struct {

	// Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)
	// Format: date-time
	DateUtc strfmt.DateTime `json:"date_utc,omitempty"`

	// List objects to be returned in full (i.e. expanded) - options include: all, stop, route, run, direction, disruption
	Expand []string `json:"expand"`

	// Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only
	IncludeCancelled bool `json:"include_cancelled,omitempty"`

	// Indicates if filtering runs (and their departures) to those that arrive at destination before date_utc (default = false). Requires max_results > 0.
	LookBackwards bool `json:"look_backwards,omitempty"`

	// Collection of departure requests
	// Required: true
	Requests []*V3StopDepartureRequest `json:"requests"`
}

V3BulkDeparturesRequest v3 bulk departures request swagger:model V3.BulkDeparturesRequest

func (*V3BulkDeparturesRequest) MarshalBinary

func (m *V3BulkDeparturesRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3BulkDeparturesRequest) UnmarshalBinary

func (m *V3BulkDeparturesRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3BulkDeparturesRequest) Validate

func (m *V3BulkDeparturesRequest) Validate(formats strfmt.Registry) error

Validate validates this v3 bulk departures request

type V3BulkDeparturesResponse

type V3BulkDeparturesResponse struct {

	// Directions of travel of route
	Directions []*V3Direction `json:"directions"`

	// Disruption information applicable to relevant routes or stops
	Disruptions map[string]V3Disruption `json:"disruptions,omitempty"`

	// Contains departures for the requested stop and route(s). It includes details as to the route_direction and whether it is still valid.
	Responses []*V3BulkDeparturesUpdateResponse `json:"responses"`

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Routes []*V3Route `json:"routes"`

	// Individual trips/services of a route
	Runs []*V3Run `json:"runs"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// A train station, tram stop, bus stop, regional coach stop or Night Bus stop
	Stops map[string]V3BulkDeparturesStopResponse `json:"stops,omitempty"`
}

V3BulkDeparturesResponse v3 bulk departures response swagger:model V3.BulkDeparturesResponse

func (*V3BulkDeparturesResponse) MarshalBinary

func (m *V3BulkDeparturesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3BulkDeparturesResponse) UnmarshalBinary

func (m *V3BulkDeparturesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3BulkDeparturesResponse) Validate

func (m *V3BulkDeparturesResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 bulk departures response

type V3BulkDeparturesRouteDirectionResponse

type V3BulkDeparturesRouteDirectionResponse struct {

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// Name of direction of travel
	DirectionName string `json:"direction_name,omitempty"`

	// Route identifier
	RouteID string `json:"route_id,omitempty"`
}

V3BulkDeparturesRouteDirectionResponse v3 bulk departures route direction response swagger:model V3.BulkDeparturesRouteDirectionResponse

func (*V3BulkDeparturesRouteDirectionResponse) MarshalBinary

func (m *V3BulkDeparturesRouteDirectionResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3BulkDeparturesRouteDirectionResponse) UnmarshalBinary

func (m *V3BulkDeparturesRouteDirectionResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3BulkDeparturesRouteDirectionResponse) Validate

Validate validates this v3 bulk departures route direction response

type V3BulkDeparturesStopResponse

type V3BulkDeparturesStopResponse struct {

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Geographic coordinate of latitude at stop
	StopLatitude float32 `json:"stop_latitude,omitempty"`

	// Geographic coordinate of longitude at stop
	StopLongitude float32 `json:"stop_longitude,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`

	// suburb of stop
	StopSuburb string `json:"stop_suburb,omitempty"`
}

V3BulkDeparturesStopResponse v3 bulk departures stop response swagger:model V3.BulkDeparturesStopResponse

func (*V3BulkDeparturesStopResponse) MarshalBinary

func (m *V3BulkDeparturesStopResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3BulkDeparturesStopResponse) UnmarshalBinary

func (m *V3BulkDeparturesStopResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3BulkDeparturesStopResponse) Validate

func (m *V3BulkDeparturesStopResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 bulk departures stop response

type V3BulkDeparturesUpdateResponse

type V3BulkDeparturesUpdateResponse struct {

	// Timetabled and real-time service departures
	Departures []*V3Departure `json:"departures"`

	// The route direction that these departures are for. Will be one of the requested route directions
	RequestedRouteDirection *V3BulkDeparturesRouteDirectionResponse `json:"requested_route_direction,omitempty"`

	// The route direction found matching the requested_route_direction
	RouteDirection *V3BulkDeparturesRouteDirectionResponse `json:"route_direction,omitempty"`

	// The status of the route direction (changed | unchanged).
	//             If changed, requests should change the requested_route_direction for the route_direction supplied.
	// Enum: [0 1]
	RouteDirectionStatus int32 `json:"route_direction_status,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`
}

V3BulkDeparturesUpdateResponse v3 bulk departures update response swagger:model V3.BulkDeparturesUpdateResponse

func (*V3BulkDeparturesUpdateResponse) MarshalBinary

func (m *V3BulkDeparturesUpdateResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3BulkDeparturesUpdateResponse) UnmarshalBinary

func (m *V3BulkDeparturesUpdateResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3BulkDeparturesUpdateResponse) Validate

func (m *V3BulkDeparturesUpdateResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 bulk departures update response

type V3Departure

type V3Departure struct {

	// Indicates if the metropolitan train service is at the platform at the time of query; returns false for other modes
	AtPlatform bool `json:"at_platform,omitempty"`

	// Chronological sequence of the departure for the run on the route. Order ascendingly by this field to get chronological order (earliest first) of departures with the same route_id and run_id.
	DepartureSequence int32 `json:"departure_sequence,omitempty"`

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// Disruption information identifier(s)
	DisruptionIds []int64 `json:"disruption_ids"`

	// Real-time estimate of departure time and date in ISO 8601 UTC format
	// Format: date-time
	EstimatedDepartureUtc strfmt.DateTime `json:"estimated_departure_utc,omitempty"`

	// Flag indicating special condition for run (e.g. RR Reservations Required, GC Guaranteed Connection, DOO Drop Off Only, PUO Pick Up Only, MO Mondays only, TU Tuesdays only, WE Wednesdays only, TH Thursdays only, FR Fridays only, SS School days only; ignore E flag)
	Flags string `json:"flags,omitempty"`

	// Platform number at stop (metropolitan train only; returns null for other modes)
	PlatformNumber string `json:"platform_number,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Trip/service run identifier
	RunID int32 `json:"run_id,omitempty"`

	// Scheduled (i.e. timetabled) departure time and date in ISO 8601 UTC format
	// Format: date-time
	ScheduledDepartureUtc strfmt.DateTime `json:"scheduled_departure_utc,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`
}

V3Departure v3 departure swagger:model V3.Departure

func (*V3Departure) MarshalBinary

func (m *V3Departure) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Departure) UnmarshalBinary

func (m *V3Departure) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Departure) Validate

func (m *V3Departure) Validate(formats strfmt.Registry) error

Validate validates this v3 departure

type V3DeparturesBroadParameters

type V3DeparturesBroadParameters struct {

	// Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)
	// Format: date-time
	DateUtc strfmt.DateTime `json:"date_utc,omitempty"`

	// Filter by identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}
	DirectionID int32 `json:"direction_id,omitempty"`

	// List objects to be returned in full (i.e. expanded) - options include: all, stop, route, run, direction, disruption
	Expand []string `json:"expand"`

	// Indicates that stop_id parameter will accept "GTFS stop_id" data
	Gtfs bool `json:"gtfs,omitempty"`

	// Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only
	IncludeCancelled bool `json:"include_cancelled,omitempty"`

	// Indicates if filtering runs (and their departures) to those that arrive at destination before date_utc (default = false). Requires max_results > 0.
	LookBackwards bool `json:"look_backwards,omitempty"`

	// Maximum number of results returned
	MaxResults int32 `json:"max_results,omitempty"`

	// Filter by platform number at stop
	PlatformNumbers []int32 `json:"platform_numbers"`
}

V3DeparturesBroadParameters v3 departures broad parameters swagger:model V3.DeparturesBroadParameters

func (*V3DeparturesBroadParameters) MarshalBinary

func (m *V3DeparturesBroadParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DeparturesBroadParameters) UnmarshalBinary

func (m *V3DeparturesBroadParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DeparturesBroadParameters) Validate

func (m *V3DeparturesBroadParameters) Validate(formats strfmt.Registry) error

Validate validates this v3 departures broad parameters

type V3DeparturesResponse

type V3DeparturesResponse struct {

	// Timetabled and real-time service departures
	Departures []*V3Departure `json:"departures"`

	// Directions of travel of route
	Directions map[string]V3Direction `json:"directions,omitempty"`

	// Disruption information applicable to relevant routes or stops
	Disruptions map[string]V3Disruption `json:"disruptions,omitempty"`

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Routes map[string]V3Route `json:"routes,omitempty"`

	// Individual trips/services of a route
	Runs map[string]V3Run `json:"runs,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// A train station, tram stop, bus stop, regional coach stop or Night Bus stop
	Stops map[string]V3ResultStop `json:"stops,omitempty"`
}

V3DeparturesResponse v3 departures response swagger:model V3.DeparturesResponse

func (*V3DeparturesResponse) MarshalBinary

func (m *V3DeparturesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DeparturesResponse) UnmarshalBinary

func (m *V3DeparturesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DeparturesResponse) Validate

func (m *V3DeparturesResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 departures response

type V3DeparturesSpecificParameters

type V3DeparturesSpecificParameters struct {

	// Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)
	// Format: date-time
	DateUtc strfmt.DateTime `json:"date_utc,omitempty"`

	// Filter by identifier of direction of travel; values returned by Directions API - /v3/directions/route/{route_id}
	DirectionID int32 `json:"direction_id,omitempty"`

	// List objects to be returned in full (i.e. expanded) - options include: all, stop, route, run, direction, disruption
	Expand []string `json:"expand"`

	// Indicates that stop_id parameter will accept "GTFS stop_id" data
	Gtfs bool `json:"gtfs,omitempty"`

	// Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only
	IncludeCancelled bool `json:"include_cancelled,omitempty"`

	// Indicates if filtering runs (and their departures) to those that arrive at destination before date_utc (default = false). Requires max_results > 0.
	LookBackwards bool `json:"look_backwards,omitempty"`

	// Maximum number of results returned
	MaxResults int32 `json:"max_results,omitempty"`
}

V3DeparturesSpecificParameters v3 departures specific parameters swagger:model V3.DeparturesSpecificParameters

func (*V3DeparturesSpecificParameters) MarshalBinary

func (m *V3DeparturesSpecificParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DeparturesSpecificParameters) UnmarshalBinary

func (m *V3DeparturesSpecificParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DeparturesSpecificParameters) Validate

func (m *V3DeparturesSpecificParameters) Validate(formats strfmt.Registry) error

Validate validates this v3 departures specific parameters

type V3Direction

type V3Direction struct {

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// Name of direction of travel
	DirectionName string `json:"direction_name,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3Direction v3 direction swagger:model V3.Direction

func (*V3Direction) MarshalBinary

func (m *V3Direction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Direction) UnmarshalBinary

func (m *V3Direction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Direction) Validate

func (m *V3Direction) Validate(formats strfmt.Registry) error

Validate validates this v3 direction

type V3DirectionWithDescription

type V3DirectionWithDescription struct {

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// Name of direction of travel
	DirectionName string `json:"direction_name,omitempty"`

	// route direction description
	RouteDirectionDescription string `json:"route_direction_description,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3DirectionWithDescription v3 direction with description swagger:model V3.DirectionWithDescription

func (*V3DirectionWithDescription) MarshalBinary

func (m *V3DirectionWithDescription) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DirectionWithDescription) UnmarshalBinary

func (m *V3DirectionWithDescription) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DirectionWithDescription) Validate

func (m *V3DirectionWithDescription) Validate(formats strfmt.Registry) error

Validate validates this v3 direction with description

type V3DirectionsResponse

type V3DirectionsResponse struct {

	// Directions of travel of route
	Directions []*V3DirectionWithDescription `json:"directions"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3DirectionsResponse v3 directions response swagger:model V3.DirectionsResponse

func (*V3DirectionsResponse) MarshalBinary

func (m *V3DirectionsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DirectionsResponse) UnmarshalBinary

func (m *V3DirectionsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DirectionsResponse) Validate

func (m *V3DirectionsResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 directions response

type V3Disruption

type V3Disruption struct {

	// colour
	Colour string `json:"colour,omitempty"`

	// Description of the disruption
	Description string `json:"description,omitempty"`

	// display on board
	DisplayOnBoard bool `json:"display_on_board,omitempty"`

	// display status
	DisplayStatus bool `json:"display_status,omitempty"`

	// Disruption information identifier
	DisruptionID int64 `json:"disruption_id,omitempty"`

	// Status of the disruption (e.g. "Planned", "Current")
	DisruptionStatus string `json:"disruption_status,omitempty"`

	// Type of disruption
	DisruptionType string `json:"disruption_type,omitempty"`

	// Date and time at which disruption begins, in ISO 8601 UTC format
	// Format: date-time
	FromDate strfmt.DateTime `json:"from_date,omitempty"`

	// Date and time disruption information was last updated by PTV, in ISO 8601 UTC format
	// Format: date-time
	LastUpdated strfmt.DateTime `json:"last_updated,omitempty"`

	// Date and time disruption information is published on PTV website, in ISO 8601 UTC format
	// Format: date-time
	PublishedOn strfmt.DateTime `json:"published_on,omitempty"`

	// Route relevant to a disruption (if applicable)
	Routes []*V3DisruptionRoute `json:"routes"`

	// Stop relevant to a disruption (if applicable)
	Stops []*V3DisruptionStop `json:"stops"`

	// Headline title summarising disruption information
	Title string `json:"title,omitempty"`

	// Date and time at which disruption ends, in ISO 8601 UTC format (returns null if unknown)
	// Format: date-time
	ToDate strfmt.DateTime `json:"to_date,omitempty"`

	// URL of relevant article on PTV website
	URL string `json:"url,omitempty"`
}

V3Disruption v3 disruption swagger:model V3.Disruption

func (*V3Disruption) MarshalBinary

func (m *V3Disruption) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Disruption) UnmarshalBinary

func (m *V3Disruption) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Disruption) Validate

func (m *V3Disruption) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption

type V3DisruptionDirection

type V3DisruptionDirection struct {

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// Name of direction of travel
	DirectionName string `json:"direction_name,omitempty"`

	// Route and direction of travel combination identifier
	RouteDirectionID int32 `json:"route_direction_id,omitempty"`

	// Time of service to which disruption applies, in 24 hour clock format (HH:MM:SS) AEDT/AEST; returns null if disruption applies to multiple (or no) services
	ServiceTime string `json:"service_time,omitempty"`
}

V3DisruptionDirection v3 disruption direction swagger:model V3.DisruptionDirection

func (*V3DisruptionDirection) MarshalBinary

func (m *V3DisruptionDirection) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionDirection) UnmarshalBinary

func (m *V3DisruptionDirection) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionDirection) Validate

func (m *V3DisruptionDirection) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption direction

type V3DisruptionMode

type V3DisruptionMode struct {

	// Disruption mode identifier
	DisruptionMode int32 `json:"disruption_mode,omitempty"`

	// Name of disruption mode
	DisruptionModeName string `json:"disruption_mode_name,omitempty"`
}

V3DisruptionMode v3 disruption mode swagger:model V3.DisruptionMode

func (*V3DisruptionMode) MarshalBinary

func (m *V3DisruptionMode) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionMode) UnmarshalBinary

func (m *V3DisruptionMode) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionMode) Validate

func (m *V3DisruptionMode) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption mode

type V3DisruptionModesResponse

type V3DisruptionModesResponse struct {

	// Transport mode identifiers
	DisruptionModes []*V3DisruptionMode `json:"disruption_modes"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3DisruptionModesResponse v3 disruption modes response swagger:model V3.DisruptionModesResponse

func (*V3DisruptionModesResponse) MarshalBinary

func (m *V3DisruptionModesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionModesResponse) UnmarshalBinary

func (m *V3DisruptionModesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionModesResponse) Validate

func (m *V3DisruptionModesResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption modes response

type V3DisruptionResponse

type V3DisruptionResponse struct {

	// Disruption information applicable to relevant routes or stops
	Disruption *V3Disruption `json:"disruption,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3DisruptionResponse v3 disruption response swagger:model V3.DisruptionResponse

func (*V3DisruptionResponse) MarshalBinary

func (m *V3DisruptionResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionResponse) UnmarshalBinary

func (m *V3DisruptionResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionResponse) Validate

func (m *V3DisruptionResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption response

type V3DisruptionRoute

type V3DisruptionRoute struct {

	// Direction of travel relevant to a disruption (if applicable)
	Direction *V3DisruptionDirection `json:"direction,omitempty"`

	// GTFS Identifer of the route
	RouteGtfsID string `json:"route_gtfs_id,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Name of route
	RouteName string `json:"route_name,omitempty"`

	// Route number presented to public (i.e. not route_id)
	RouteNumber string `json:"route_number,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3DisruptionRoute v3 disruption route swagger:model V3.DisruptionRoute

func (*V3DisruptionRoute) MarshalBinary

func (m *V3DisruptionRoute) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionRoute) UnmarshalBinary

func (m *V3DisruptionRoute) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionRoute) Validate

func (m *V3DisruptionRoute) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption route

type V3DisruptionStop

type V3DisruptionStop struct {

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`
}

V3DisruptionStop v3 disruption stop swagger:model V3.DisruptionStop

func (*V3DisruptionStop) MarshalBinary

func (m *V3DisruptionStop) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionStop) UnmarshalBinary

func (m *V3DisruptionStop) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionStop) Validate

func (m *V3DisruptionStop) Validate(formats strfmt.Registry) error

Validate validates this v3 disruption stop

type V3Disruptions

type V3Disruptions struct {

	// Subset of disruption information applicable to ferry
	Ferry []*V3Disruption `json:"ferry"`

	// Subset of disruption information applicable to multiple route_types
	General []*V3Disruption `json:"general"`

	// Subset of disruption information applicable to interstate train
	InterstateTrain []*V3Disruption `json:"interstate_train"`

	// Subset of disruption information applicable to metropolitan bus
	MetroBus []*V3Disruption `json:"metro_bus"`

	// Subset of disruption information applicable to metropolitan train
	MetroTrain []*V3Disruption `json:"metro_train"`

	// Subset of disruption information applicable to metropolitan tram
	MetroTram []*V3Disruption `json:"metro_tram"`

	// Subset of disruption information applicable to night bus
	NightBus []*V3Disruption `json:"night_bus"`

	// Subset of disruption information applicable to regional bus
	RegionalBus []*V3Disruption `json:"regional_bus"`

	// Subset of disruption information applicable to V/Line coach
	RegionalCoach []*V3Disruption `json:"regional_coach"`

	// Subset of disruption information applicable to V/Line train
	RegionalTrain []*V3Disruption `json:"regional_train"`

	// Subset of disruption information applicable to school bus
	SchoolBus []*V3Disruption `json:"school_bus"`

	// Subset of disruption information applicable to skybus
	Skybus []*V3Disruption `json:"skybus"`

	// Subset of disruption information applicable to taxi
	Taxi []*V3Disruption `json:"taxi"`

	// Subset of disruption information applicable to telebus services
	Telebus []*V3Disruption `json:"telebus"`
}

V3Disruptions v3 disruptions swagger:model V3.Disruptions

func (*V3Disruptions) MarshalBinary

func (m *V3Disruptions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Disruptions) UnmarshalBinary

func (m *V3Disruptions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Disruptions) Validate

func (m *V3Disruptions) Validate(formats strfmt.Registry) error

Validate validates this v3 disruptions

type V3DisruptionsResponse

type V3DisruptionsResponse struct {

	// Disruption information applicable to relevant routes or stops
	Disruptions *V3Disruptions `json:"disruptions,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3DisruptionsResponse v3 disruptions response swagger:model V3.DisruptionsResponse

func (*V3DisruptionsResponse) MarshalBinary

func (m *V3DisruptionsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3DisruptionsResponse) UnmarshalBinary

func (m *V3DisruptionsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3DisruptionsResponse) Validate

func (m *V3DisruptionsResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 disruptions response

type V3ErrorResponse

type V3ErrorResponse struct {

	// Error message
	Message string `json:"message,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3ErrorResponse An error response swagger:model V3.ErrorResponse

func (*V3ErrorResponse) MarshalBinary

func (m *V3ErrorResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3ErrorResponse) UnmarshalBinary

func (m *V3ErrorResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3ErrorResponse) Validate

func (m *V3ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 error response

type V3Outlet

type V3Outlet struct {

	// The business name of the outlet
	OutletBusiness string `json:"outlet_business,omitempty"`

	// The business hours on Friday
	OutletBusinessHourFri string `json:"outlet_business_hour_fri,omitempty"`

	// The business hours on Monday
	OutletBusinessHourMon string `json:"outlet_business_hour_mon,omitempty"`

	// The business hours on Saturday
	OutletBusinessHourSat string `json:"outlet_business_hour_sat,omitempty"`

	// The business hours on Sunday
	OutletBusinessHourSun string `json:"outlet_business_hour_sun,omitempty"`

	// The business hours on Thursday
	OutletBusinessHourThur string `json:"outlet_business_hour_thur,omitempty"`

	// The business hours on Tuesday
	OutletBusinessHourTue string `json:"outlet_business_hour_tue,omitempty"`

	// The business hours on Wednesday
	OutletBusinessHourWed string `json:"outlet_business_hour_wed,omitempty"`

	// Geographic coordinate of latitude at outlet
	OutletLatitude float32 `json:"outlet_latitude,omitempty"`

	// Geographic coordinate of longitude at outlet
	OutletLongitude float32 `json:"outlet_longitude,omitempty"`

	// The location name of the outlet
	OutletName string `json:"outlet_name,omitempty"`

	// Any additional notes for the outlet such as 'Buy pre-loaded myki cards only'. May be null/empty.
	OutletNotes string `json:"outlet_notes,omitempty"`

	// The postcode for the outlet
	OutletPostcode int32 `json:"outlet_postcode,omitempty"`

	// The SLID / SPID
	OutletSlidSpid string `json:"outlet_slid_spid,omitempty"`

	// The city/municipality the outlet is in
	OutletSuburb string `json:"outlet_suburb,omitempty"`
}

V3Outlet v3 outlet swagger:model V3.Outlet

func (*V3Outlet) MarshalBinary

func (m *V3Outlet) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Outlet) UnmarshalBinary

func (m *V3Outlet) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Outlet) Validate

func (m *V3Outlet) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet

type V3OutletGeolocation

type V3OutletGeolocation struct {

	// The business name of the outlet
	OutletBusiness string `json:"outlet_business,omitempty"`

	// The business hours on Friday
	OutletBusinessHourFri string `json:"outlet_business_hour_fri,omitempty"`

	// The business hours on Monday
	OutletBusinessHourMon string `json:"outlet_business_hour_mon,omitempty"`

	// The business hours on Saturday
	OutletBusinessHourSat string `json:"outlet_business_hour_sat,omitempty"`

	// The business hours on Sunday
	OutletBusinessHourSun string `json:"outlet_business_hour_sun,omitempty"`

	// The business hours on Thursday
	OutletBusinessHourThur string `json:"outlet_business_hour_thur,omitempty"`

	// The business hours on Tuesday
	OutletBusinessHourTue string `json:"outlet_business_hour_tue,omitempty"`

	// The business hours on Wednesday
	OutletBusinessHourWed string `json:"outlet_business_hour_wed,omitempty"`

	// Distance of outlet from input location (in metres); returns 0 if no location is input
	OutletDistance float32 `json:"outlet_distance,omitempty"`

	// Geographic coordinate of latitude at outlet
	OutletLatitude float32 `json:"outlet_latitude,omitempty"`

	// Geographic coordinate of longitude at outlet
	OutletLongitude float32 `json:"outlet_longitude,omitempty"`

	// The location name of the outlet
	OutletName string `json:"outlet_name,omitempty"`

	// Any additional notes for the outlet such as 'Buy pre-loaded myki cards only'. May be null/empty.
	OutletNotes string `json:"outlet_notes,omitempty"`

	// The postcode for the outlet
	OutletPostcode int32 `json:"outlet_postcode,omitempty"`

	// The SLID / SPID
	OutletSlidSpid string `json:"outlet_slid_spid,omitempty"`

	// The city/municipality the outlet is in
	OutletSuburb string `json:"outlet_suburb,omitempty"`
}

V3OutletGeolocation v3 outlet geolocation swagger:model V3.OutletGeolocation

func (*V3OutletGeolocation) MarshalBinary

func (m *V3OutletGeolocation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3OutletGeolocation) UnmarshalBinary

func (m *V3OutletGeolocation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3OutletGeolocation) Validate

func (m *V3OutletGeolocation) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet geolocation

type V3OutletGeolocationParameters

type V3OutletGeolocationParameters struct {

	// Filter by maximum distance (in metres) from location specified via latitude and longitude parameters (default = 300)
	MaxDistance float64 `json:"max_distance,omitempty"`

	// Maximum number of results returned (default = 30)
	MaxResults int32 `json:"max_results,omitempty"`
}

V3OutletGeolocationParameters v3 outlet geolocation parameters swagger:model V3.OutletGeolocationParameters

func (*V3OutletGeolocationParameters) MarshalBinary

func (m *V3OutletGeolocationParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3OutletGeolocationParameters) UnmarshalBinary

func (m *V3OutletGeolocationParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3OutletGeolocationParameters) Validate

func (m *V3OutletGeolocationParameters) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet geolocation parameters

type V3OutletGeolocationResponse

type V3OutletGeolocationResponse struct {

	// myki ticket outlets
	Outlets []*V3OutletGeolocation `json:"outlets"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3OutletGeolocationResponse v3 outlet geolocation response swagger:model V3.OutletGeolocationResponse

func (*V3OutletGeolocationResponse) MarshalBinary

func (m *V3OutletGeolocationResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3OutletGeolocationResponse) UnmarshalBinary

func (m *V3OutletGeolocationResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3OutletGeolocationResponse) Validate

func (m *V3OutletGeolocationResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet geolocation response

type V3OutletParameters

type V3OutletParameters struct {

	// Maximum number of results returned (default = 30)
	MaxResults int32 `json:"max_results,omitempty"`
}

V3OutletParameters v3 outlet parameters swagger:model V3.OutletParameters

func (*V3OutletParameters) MarshalBinary

func (m *V3OutletParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3OutletParameters) UnmarshalBinary

func (m *V3OutletParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3OutletParameters) Validate

func (m *V3OutletParameters) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet parameters

type V3OutletResponse

type V3OutletResponse struct {

	// myki ticket outlets
	Outlets []*V3Outlet `json:"outlets"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3OutletResponse v3 outlet response swagger:model V3.OutletResponse

func (*V3OutletResponse) MarshalBinary

func (m *V3OutletResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3OutletResponse) UnmarshalBinary

func (m *V3OutletResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3OutletResponse) Validate

func (m *V3OutletResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 outlet response

type V3ResultOutlet

type V3ResultOutlet struct {

	// The business name of the outlet
	OutletBusiness string `json:"outlet_business,omitempty"`

	// The business hours on Friday
	OutletBusinessHourFri string `json:"outlet_business_hour_fri,omitempty"`

	// The business hours on Monday
	OutletBusinessHourMon string `json:"outlet_business_hour_mon,omitempty"`

	// The business hours on Saturday
	OutletBusinessHourSat string `json:"outlet_business_hour_sat,omitempty"`

	// The business hours on Sunday
	OutletBusinessHourSun string `json:"outlet_business_hour_sun,omitempty"`

	// The business hours on Thursday
	OutletBusinessHourThur string `json:"outlet_business_hour_thur,omitempty"`

	// The business hours on Tuesday
	OutletBusinessHourTue string `json:"outlet_business_hour_tue,omitempty"`

	// The business hours on Wednesday
	OutletBusinessHourWed string `json:"outlet_business_hour_wed,omitempty"`

	// Distance of outlet from input location (in metres); returns 0 if no location is input
	OutletDistance float32 `json:"outlet_distance,omitempty"`

	// Geographic coordinate of latitude at outlet
	OutletLatitude float32 `json:"outlet_latitude,omitempty"`

	// Geographic coordinate of longitude at outlet
	OutletLongitude float32 `json:"outlet_longitude,omitempty"`

	// The location name of the outlet
	OutletName string `json:"outlet_name,omitempty"`

	// Any additional notes for the outlet such as 'Buy pre-loaded myki cards only'. May be null/empty.
	OutletNotes string `json:"outlet_notes,omitempty"`

	// The postcode for the outlet
	OutletPostcode int32 `json:"outlet_postcode,omitempty"`

	// The SLID / SPID
	OutletSlidSpid string `json:"outlet_slid_spid,omitempty"`

	// The city/municipality the outlet is in
	OutletSuburb string `json:"outlet_suburb,omitempty"`
}

V3ResultOutlet v3 result outlet swagger:model V3.ResultOutlet

func (*V3ResultOutlet) MarshalBinary

func (m *V3ResultOutlet) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3ResultOutlet) UnmarshalBinary

func (m *V3ResultOutlet) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3ResultOutlet) Validate

func (m *V3ResultOutlet) Validate(formats strfmt.Registry) error

Validate validates this v3 result outlet

type V3ResultRoute

type V3ResultRoute struct {

	// GTFS Identifer of the route
	RouteGtfsID string `json:"route_gtfs_id,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Name of route
	RouteName string `json:"route_name,omitempty"`

	// Route number presented to public (nb. not route_id)
	RouteNumber string `json:"route_number,omitempty"`

	// Service status for the route (indicates disruptions)
	RouteServiceStatus *V3RouteServiceStatus `json:"route_service_status,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3ResultRoute v3 result route swagger:model V3.ResultRoute

func (*V3ResultRoute) MarshalBinary

func (m *V3ResultRoute) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3ResultRoute) UnmarshalBinary

func (m *V3ResultRoute) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3ResultRoute) Validate

func (m *V3ResultRoute) Validate(formats strfmt.Registry) error

Validate validates this v3 result route

type V3ResultStop

type V3ResultStop struct {

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Distance of stop from input location (in metres); returns 0 if no location is input
	StopDistance float32 `json:"stop_distance,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Geographic coordinate of latitude at stop
	StopLatitude float32 `json:"stop_latitude,omitempty"`

	// Geographic coordinate of longitude at stop
	StopLongitude float32 `json:"stop_longitude,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`

	// Sequence of the stop on the route/run; return 0 when route_id or run_id not specified. Order ascendingly by this field (when non zero) to get physical order (earliest first) of stops on the route_id/run_id.
	StopSequence int32 `json:"stop_sequence,omitempty"`

	// suburb of stop
	StopSuburb string `json:"stop_suburb,omitempty"`
}

V3ResultStop v3 result stop swagger:model V3.ResultStop

func (*V3ResultStop) MarshalBinary

func (m *V3ResultStop) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3ResultStop) UnmarshalBinary

func (m *V3ResultStop) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3ResultStop) Validate

func (m *V3ResultStop) Validate(formats strfmt.Registry) error

Validate validates this v3 result stop

type V3Route

type V3Route struct {

	// GTFS Identifer of the route
	RouteGtfsID string `json:"route_gtfs_id,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Name of route
	RouteName string `json:"route_name,omitempty"`

	// Route number presented to public (nb. not route_id)
	RouteNumber string `json:"route_number,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3Route v3 route swagger:model V3.Route

func (*V3Route) MarshalBinary

func (m *V3Route) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Route) UnmarshalBinary

func (m *V3Route) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Route) Validate

func (m *V3Route) Validate(formats strfmt.Registry) error

Validate validates this v3 route

type V3RouteDeparturesSpecificParameters

type V3RouteDeparturesSpecificParameters struct {

	// Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)
	// Format: date-time
	DateUtc strfmt.DateTime `json:"date_utc,omitempty"`

	// List objects to be returned in full (i.e. expanded) - options include: all, stop, route, run, direction, disruption
	Expand []string `json:"expand"`

	// Indicates if cancelled services (if they exist) are returned (default = false) - metropolitan train only
	IncludeCancelled bool `json:"include_cancelled,omitempty"`

	// Indicates if filtering runs (and their departures) to those that arrive at destination before date_utc (default = false). Requires max_results > 0.
	LookBackwards bool `json:"look_backwards,omitempty"`

	// Maximum number of results returned
	MaxResults int32 `json:"max_results,omitempty"`

	// When set to true, all timetable information returned by Chronos will be sourced from the Parser timetables,
	//             while when set to false (default state), the real-time departure information and operational time from
	//             Metro CIS will continue to be returned where available.
	TrainScheduledTimetables bool `json:"train_scheduled_timetables,omitempty"`
}

V3RouteDeparturesSpecificParameters v3 route departures specific parameters swagger:model V3.RouteDeparturesSpecificParameters

func (*V3RouteDeparturesSpecificParameters) MarshalBinary

func (m *V3RouteDeparturesSpecificParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteDeparturesSpecificParameters) UnmarshalBinary

func (m *V3RouteDeparturesSpecificParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteDeparturesSpecificParameters) Validate

Validate validates this v3 route departures specific parameters

type V3RouteResponse

type V3RouteResponse struct {

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Route *V3RouteWithStatus `json:"route,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3RouteResponse v3 route response swagger:model V3.RouteResponse

func (*V3RouteResponse) MarshalBinary

func (m *V3RouteResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteResponse) UnmarshalBinary

func (m *V3RouteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteResponse) Validate

func (m *V3RouteResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 route response

type V3RouteServiceStatus

type V3RouteServiceStatus struct {

	// description
	Description string `json:"description,omitempty"`

	// timestamp
	// Format: date-time
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
}

V3RouteServiceStatus v3 route service status swagger:model V3.RouteServiceStatus

func (*V3RouteServiceStatus) MarshalBinary

func (m *V3RouteServiceStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteServiceStatus) UnmarshalBinary

func (m *V3RouteServiceStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteServiceStatus) Validate

func (m *V3RouteServiceStatus) Validate(formats strfmt.Registry) error

Validate validates this v3 route service status

type V3RouteType

type V3RouteType struct {

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Name of transport mode
	RouteTypeName string `json:"route_type_name,omitempty"`
}

V3RouteType v3 route type swagger:model V3.RouteType

func (*V3RouteType) MarshalBinary

func (m *V3RouteType) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteType) UnmarshalBinary

func (m *V3RouteType) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteType) Validate

func (m *V3RouteType) Validate(formats strfmt.Registry) error

Validate validates this v3 route type

type V3RouteTypesResponse

type V3RouteTypesResponse struct {

	// Transport mode identifiers
	RouteTypes []*V3RouteType `json:"route_types"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3RouteTypesResponse v3 route types response swagger:model V3.RouteTypesResponse

func (*V3RouteTypesResponse) MarshalBinary

func (m *V3RouteTypesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteTypesResponse) UnmarshalBinary

func (m *V3RouteTypesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteTypesResponse) Validate

func (m *V3RouteTypesResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 route types response

type V3RouteWithStatus

type V3RouteWithStatus struct {

	// GTFS Identifer of the route
	RouteGtfsID string `json:"route_gtfs_id,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Name of route
	RouteName string `json:"route_name,omitempty"`

	// Route number presented to public (nb. not route_id)
	RouteNumber string `json:"route_number,omitempty"`

	// Service status for the route (indicates disruptions)
	RouteServiceStatus *V3RouteServiceStatus `json:"route_service_status,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`
}

V3RouteWithStatus v3 route with status swagger:model V3.RouteWithStatus

func (*V3RouteWithStatus) MarshalBinary

func (m *V3RouteWithStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RouteWithStatus) UnmarshalBinary

func (m *V3RouteWithStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RouteWithStatus) Validate

func (m *V3RouteWithStatus) Validate(formats strfmt.Registry) error

Validate validates this v3 route with status

type V3RoutesResponse

type V3RoutesResponse struct {

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Routes []*V3RouteWithStatus `json:"routes"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3RoutesResponse v3 routes response swagger:model V3.RoutesResponse

func (*V3RoutesResponse) MarshalBinary

func (m *V3RoutesResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RoutesResponse) UnmarshalBinary

func (m *V3RoutesResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RoutesResponse) Validate

func (m *V3RoutesResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 routes response

type V3Run

type V3Run struct {

	// Name of destination of run
	DestinationName string `json:"destination_name,omitempty"`

	// Direction of travel identifier
	DirectionID int32 `json:"direction_id,omitempty"`

	// The number of remaining skipped/express stations for the run/service from a stop
	ExpressStopCount int32 `json:"express_stop_count,omitempty"`

	// stop_id of final stop of run
	FinalStopID int32 `json:"final_stop_id,omitempty"`

	// Route identifier
	RouteID int32 `json:"route_id,omitempty"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Trip/service run identifier
	RunID int32 `json:"run_id,omitempty"`

	// Chronological sequence of the trip/service run on the route in direction. Order ascendingly by this field to get chronological order (earliest first) of runs with the same route_id and direction_id.
	RunSequence int32 `json:"run_sequence,omitempty"`

	// Status of metropolitan train run; returns "scheduled" for other modes
	Status string `json:"status,omitempty"`

	// Descriptor of the trip/service run. Only available for some runs. May be null.
	VehicleDescriptor *V3VehicleDescriptor `json:"vehicle_descriptor,omitempty"`

	// Position of the trip/service run. Only available for some bus runs. May be null.
	VehiclePosition *V3VehiclePosition `json:"vehicle_position,omitempty"`
}

V3Run v3 run swagger:model V3.Run

func (*V3Run) MarshalBinary

func (m *V3Run) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Run) UnmarshalBinary

func (m *V3Run) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Run) Validate

func (m *V3Run) Validate(formats strfmt.Registry) error

Validate validates this v3 run

type V3RunResponse

type V3RunResponse struct {

	// Individual trip/service of a route
	Run *V3Run `json:"run,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3RunResponse v3 run response swagger:model V3.RunResponse

func (*V3RunResponse) MarshalBinary

func (m *V3RunResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RunResponse) UnmarshalBinary

func (m *V3RunResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RunResponse) Validate

func (m *V3RunResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 run response

type V3RunsResponse

type V3RunsResponse struct {

	// Individual trips/services of a route
	Runs []*V3Run `json:"runs"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`
}

V3RunsResponse v3 runs response swagger:model V3.RunsResponse

func (*V3RunsResponse) MarshalBinary

func (m *V3RunsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3RunsResponse) UnmarshalBinary

func (m *V3RunsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3RunsResponse) Validate

func (m *V3RunsResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 runs response

type V3SearchParameters

type V3SearchParameters struct {

	// Placeholder for future development; currently unavailable
	IncludeAddresses bool `json:"include_addresses,omitempty"`

	// Indicates if outlets will be returned in response (default = true)
	IncludeOutlets bool `json:"include_outlets,omitempty"`

	// Filter by geographic coordinate of latitude
	Latitude float32 `json:"latitude,omitempty"`

	// Filter by geographic coordinate of longitude
	Longitude float32 `json:"longitude,omitempty"`

	// Indicates whether to find routes by suburbs in the search term (default = true)
	MatchRouteBySuburb bool `json:"match_route_by_suburb,omitempty"`

	// Indicates whether to search for stops according to a metlink stop ID (default = false)
	MatchStopByGtfsStopID bool `json:"match_stop_by_gtfs_stop_id,omitempty"`

	// Indicates whether to find stops by suburbs in the search term (default = true)
	MatchStopBySuburb bool `json:"match_stop_by_suburb,omitempty"`

	// Filter by maximum distance (in metres) from location specified via latitude and longitude parameters
	MaxDistance float32 `json:"max_distance,omitempty"`

	// Filter by route_type; values returned via RouteTypes API (note: stops and routes are ordered by route_types specified)
	RouteTypes []int32 `json:"route_types"`
}

V3SearchParameters v3 search parameters swagger:model V3.SearchParameters

func (*V3SearchParameters) MarshalBinary

func (m *V3SearchParameters) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3SearchParameters) UnmarshalBinary

func (m *V3SearchParameters) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3SearchParameters) Validate

func (m *V3SearchParameters) Validate(formats strfmt.Registry) error

Validate validates this v3 search parameters

type V3SearchResult

type V3SearchResult struct {

	// myki ticket outlets
	Outlets []*V3ResultOutlet `json:"outlets"`

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Routes []*V3ResultRoute `json:"routes"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// Train stations, tram stops, bus stops, regional coach stops or Night Bus stops
	Stops []*V3ResultStop `json:"stops"`
}

V3SearchResult v3 search result swagger:model V3.SearchResult

func (*V3SearchResult) MarshalBinary

func (m *V3SearchResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3SearchResult) UnmarshalBinary

func (m *V3SearchResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3SearchResult) Validate

func (m *V3SearchResult) Validate(formats strfmt.Registry) error

Validate validates this v3 search result

type V3Status

type V3Status struct {

	// API system health status (0=offline, 1=online)
	// Enum: [0 1]
	Health int32 `json:"health,omitempty"`

	// API Version number
	Version string `json:"version,omitempty"`
}

V3Status v3 status swagger:model V3.Status

func (*V3Status) MarshalBinary

func (m *V3Status) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3Status) UnmarshalBinary

func (m *V3Status) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3Status) Validate

func (m *V3Status) Validate(formats strfmt.Registry) error

Validate validates this v3 status

type V3StopAccessibility

type V3StopAccessibility struct {

	// Indicates if there is at least one audio customer information at the stop/platform
	AudioCustomerInformation bool `json:"audio_customer_information,omitempty"`

	// Indicates if there is at least one accessible escalator at the stop/platform that complies with the Disability Standards for Accessible Public Transport under the Disability Discrimination Act (1992)
	Escalator bool `json:"escalator,omitempty"`

	// Indicates if there is a hearing loop facility at the stop/platform
	HearingLoop bool `json:"hearing_loop,omitempty"`

	// Indicates if there is an elevator at the stop/platform
	Lift bool `json:"lift,omitempty"`

	// Indicates if there is lighting at the stop
	Lighting bool `json:"lighting,omitempty"`

	// Indicates the platform number for xivic information (Platform 0 indicates general stop facilities)
	PlatformNumber int32 `json:"platform_number,omitempty"`

	// Indicates if there are stairs available in the stop
	Stairs bool `json:"stairs,omitempty"`

	// Indicates if the stop is accessible
	StopAccessible bool `json:"stop_accessible,omitempty"`

	// Indicates if there are tactile tiles (also known as tactile ground surface indicators, or TGSIs) at the stop
	TactileGroundSurfaceIndicator bool `json:"tactile_ground_surface_indicator,omitempty"`

	// Indicates if there is a general waiting area at the stop
	WaitingRoom bool `json:"waiting_room,omitempty"`

	// Facilities relating to the accessibility of the stop by wheelchair
	Wheelchair *V3StopAccessibilityWheelchair `json:"wheelchair,omitempty"`
}

V3StopAccessibility v3 stop accessibility swagger:model V3.StopAccessibility

func (*V3StopAccessibility) MarshalBinary

func (m *V3StopAccessibility) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopAccessibility) UnmarshalBinary

func (m *V3StopAccessibility) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopAccessibility) Validate

func (m *V3StopAccessibility) Validate(formats strfmt.Registry) error

Validate validates this v3 stop accessibility

type V3StopAccessibilityWheelchair

type V3StopAccessibilityWheelchair struct {

	// accessible ramp
	AccessibleRamp bool `json:"accessible_ramp,omitempty"`

	// Indicates if there is at least one low ticket counter at the stop that complies with the Disability Standards for Accessible Public Transport under the Disability Discrimination Act (1992)
	LowTicketCounter bool `json:"low_ticket_counter,omitempty"`

	// Indicates if there is a space for mobility device to board on or off a transport mode
	Manouvering bool `json:"manouvering,omitempty"`

	// Indicates if there is at least one accessible parking spot at the stop that complies with the Disability Standards for Accessible Public Transport under the Disability Discrimination Act (1992)
	Parking bool `json:"parking,omitempty"`

	// Indicates if there is a raised platform to board a train
	RaisedPlatform bool `json:"raised_platform,omitempty"`

	// Indicates if there is shelter near the raised platform
	RaisedPlatformShelther bool `json:"raised_platform_shelther,omitempty"`

	// Indicates if there are ramps (<1:14) at the stop/platform
	Ramp bool `json:"ramp,omitempty"`

	// Indicates if there is a path beyond the stop which is accessible
	SecondaryPath bool `json:"secondary_path,omitempty"`

	// Indicates if there are ramps (>1:14) at the stop/platform
	SteepRamp bool `json:"steep_ramp,omitempty"`

	// Indicates if there is at least one accessible telephone at the stop/platform that complies with the Disability Standards for Accessible Public Transport under the Disability Discrimination Act (1992)
	Telephone bool `json:"telephone,omitempty"`

	// Indicates if there is at least one accessible toilet at the stop/platform that complies with the Disability Standards for Accessible Public Transport under the Disability Discrimination Act (1992)
	Toilet bool `json:"toilet,omitempty"`
}

V3StopAccessibilityWheelchair v3 stop accessibility wheelchair swagger:model V3.StopAccessibilityWheelchair

func (*V3StopAccessibilityWheelchair) MarshalBinary

func (m *V3StopAccessibilityWheelchair) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopAccessibilityWheelchair) UnmarshalBinary

func (m *V3StopAccessibilityWheelchair) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopAccessibilityWheelchair) Validate

func (m *V3StopAccessibilityWheelchair) Validate(formats strfmt.Registry) error

Validate validates this v3 stop accessibility wheelchair

type V3StopAmenityDetails

type V3StopAmenityDetails struct {

	// The number of free car parking spots at the stop
	CarParking string `json:"car_parking,omitempty"`

	// Indicates if there are CCTV (i.e. closed circuit television) cameras at the stop
	Cctv bool `json:"cctv,omitempty"`

	// Indicates if there is a taxi rank at or near the stop
	TaxiRank bool `json:"taxi_rank,omitempty"`

	// Indicates if there is a public toilet at or near the stop
	Toilet bool `json:"toilet,omitempty"`
}

V3StopAmenityDetails v3 stop amenity details swagger:model V3.StopAmenityDetails

func (*V3StopAmenityDetails) MarshalBinary

func (m *V3StopAmenityDetails) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopAmenityDetails) UnmarshalBinary

func (m *V3StopAmenityDetails) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopAmenityDetails) Validate

func (m *V3StopAmenityDetails) Validate(formats strfmt.Registry) error

Validate validates this v3 stop amenity details

type V3StopBase

type V3StopBase struct {

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`
}

V3StopBase v3 stop base swagger:model V3.StopBase

func (*V3StopBase) MarshalBinary

func (m *V3StopBase) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopBase) UnmarshalBinary

func (m *V3StopBase) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopBase) Validate

func (m *V3StopBase) Validate(formats strfmt.Registry) error

Validate validates this v3 stop base

type V3StopDepartureRequest

type V3StopDepartureRequest struct {

	// Indicates that stop_id parameter will accept "GTFS stop_id" data and route_directions[x].route_id parameters will accept route_gtfs_id data
	Gtfs bool `json:"gtfs,omitempty"`

	// Maximum number of results returned
	// Maximum: 2.147483647e+09
	// Minimum: 0
	MaxResults *int32 `json:"max_results,omitempty"`

	// The route directions to find departures for at this stop.
	// Required: true
	RouteDirections []*V3StopDepartureRequestRouteDirection `json:"route_directions"`

	// Number identifying transport mode; values returned via RouteTypes API
	// Enum: [0 1 2 3 4]
	RouteType int32 `json:"route_type,omitempty"`

	// Identifier of stop; values returned by Stops API
	// Maximum: 2.147483647e+09
	// Minimum: 0
	StopID *int32 `json:"stop_id,omitempty"`
}

V3StopDepartureRequest v3 stop departure request swagger:model V3.StopDepartureRequest

func (*V3StopDepartureRequest) MarshalBinary

func (m *V3StopDepartureRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopDepartureRequest) UnmarshalBinary

func (m *V3StopDepartureRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopDepartureRequest) Validate

func (m *V3StopDepartureRequest) Validate(formats strfmt.Registry) error

Validate validates this v3 stop departure request

type V3StopDepartureRequestRouteDirection

type V3StopDepartureRequestRouteDirection struct {

	// Direction of travel identifier; values returned by Directions API - v3/directions
	// Maximum: 2.147483647e+09
	// Minimum: 0
	DirectionID *int32 `json:"direction_id,omitempty"`

	// Name of direction of travel; values returned by Directions API - v3/directions
	// Required: true
	DirectionName *string `json:"direction_name"`

	// Identifier of route; values returned by Routes API - v3/routes
	RouteID string `json:"route_id,omitempty"`
}

V3StopDepartureRequestRouteDirection v3 stop departure request route direction swagger:model V3.StopDepartureRequestRouteDirection

func (*V3StopDepartureRequestRouteDirection) MarshalBinary

func (m *V3StopDepartureRequestRouteDirection) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopDepartureRequestRouteDirection) UnmarshalBinary

func (m *V3StopDepartureRequestRouteDirection) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopDepartureRequestRouteDirection) Validate

Validate validates this v3 stop departure request route direction

type V3StopDetails

type V3StopDetails struct {

	// Disruption information identifier(s)
	DisruptionIds []int64 `json:"disruption_ids"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// The definition applicable to the station_type; returns null for V/Line train
	StationDescription string `json:"station_description,omitempty"`

	// Type of metropolitan train station (i.e. "Premium", "Host" or "Unstaffed" station); returns null for V/Line train
	StationType string `json:"station_type,omitempty"`

	// Facilities relating to the accessibility of the stop
	StopAccessibility *V3StopAccessibility `json:"stop_accessibility,omitempty"`

	// Amenity and facility details at the stop
	StopAmenities *V3StopAmenityDetails `json:"stop_amenities,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Location details of the stop
	StopLocation *V3StopLocation `json:"stop_location,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`

	// Staffing details for the stop
	StopStaffing *V3StopStaffing `json:"stop_staffing,omitempty"`
}

V3StopDetails v3 stop details swagger:model V3.StopDetails

func (*V3StopDetails) MarshalBinary

func (m *V3StopDetails) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopDetails) UnmarshalBinary

func (m *V3StopDetails) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopDetails) Validate

func (m *V3StopDetails) Validate(formats strfmt.Registry) error

Validate validates this v3 stop details

type V3StopGeosearch

type V3StopGeosearch struct {

	// Disruption information identifier(s)
	DisruptionIds []int64 `json:"disruption_ids"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Distance of stop from input location (in metres); returns 0 if no location is input
	StopDistance float32 `json:"stop_distance,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Geographic coordinate of latitude at stop
	StopLatitude float32 `json:"stop_latitude,omitempty"`

	// Geographic coordinate of longitude at stop
	StopLongitude float32 `json:"stop_longitude,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`

	// Sequence of the stop on the route/run; return 0 when route_id or run_id not specified. Order ascendingly by this field (when non zero) to get physical order (earliest first) of stops on the route_id/run_id.
	StopSequence int32 `json:"stop_sequence,omitempty"`

	// suburb of stop
	StopSuburb string `json:"stop_suburb,omitempty"`
}

V3StopGeosearch v3 stop geosearch swagger:model V3.StopGeosearch

func (*V3StopGeosearch) MarshalBinary

func (m *V3StopGeosearch) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopGeosearch) UnmarshalBinary

func (m *V3StopGeosearch) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopGeosearch) Validate

func (m *V3StopGeosearch) Validate(formats strfmt.Registry) error

Validate validates this v3 stop geosearch

type V3StopGps

type V3StopGps struct {

	// Geographic coordinate of latitude at stop
	Latitude float32 `json:"latitude,omitempty"`

	// Geographic coordinate of longitude at stop
	Longitude float32 `json:"longitude,omitempty"`
}

V3StopGps v3 stop gps swagger:model V3.StopGps

func (*V3StopGps) MarshalBinary

func (m *V3StopGps) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopGps) UnmarshalBinary

func (m *V3StopGps) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopGps) Validate

func (m *V3StopGps) Validate(formats strfmt.Registry) error

Validate validates this v3 stop gps

type V3StopLocation

type V3StopLocation struct {

	// GPS coordinates of the stop
	Gps *V3StopGps `json:"gps,omitempty"`
}

V3StopLocation v3 stop location swagger:model V3.StopLocation

func (*V3StopLocation) MarshalBinary

func (m *V3StopLocation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopLocation) UnmarshalBinary

func (m *V3StopLocation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopLocation) Validate

func (m *V3StopLocation) Validate(formats strfmt.Registry) error

Validate validates this v3 stop location

type V3StopOnRoute

type V3StopOnRoute struct {

	// Disruption information identifier(s)
	DisruptionIds []int64 `json:"disruption_ids"`

	// Transport mode identifier
	RouteType int32 `json:"route_type,omitempty"`

	// Stop identifier
	StopID int32 `json:"stop_id,omitempty"`

	// Geographic coordinate of latitude at stop
	StopLatitude float32 `json:"stop_latitude,omitempty"`

	// Geographic coordinate of longitude at stop
	StopLongitude float32 `json:"stop_longitude,omitempty"`

	// Name of stop
	StopName string `json:"stop_name,omitempty"`

	// Sequence of the stop on the route/run; return 0 when route_id or run_id not specified. Order ascendingly by this field (when non zero) to get physical order (earliest first) of stops on the route_id/run_id.
	StopSequence int32 `json:"stop_sequence,omitempty"`

	// suburb of stop
	StopSuburb string `json:"stop_suburb,omitempty"`
}

V3StopOnRoute v3 stop on route swagger:model V3.StopOnRoute

func (*V3StopOnRoute) MarshalBinary

func (m *V3StopOnRoute) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopOnRoute) UnmarshalBinary

func (m *V3StopOnRoute) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopOnRoute) Validate

func (m *V3StopOnRoute) Validate(formats strfmt.Registry) error

Validate validates this v3 stop on route

type V3StopResponse

type V3StopResponse struct {

	// Disruption information applicable to relevant routes or stops
	Disruptions map[string]V3Disruption `json:"disruptions,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// A metropolitan or V/Line train station
	Stop *V3StopDetails `json:"stop,omitempty"`
}

V3StopResponse v3 stop response swagger:model V3.StopResponse

func (*V3StopResponse) MarshalBinary

func (m *V3StopResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopResponse) UnmarshalBinary

func (m *V3StopResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopResponse) Validate

func (m *V3StopResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 stop response

type V3StopStaffing

type V3StopStaffing struct {

	// Stop staffing hours
	FriAmFrom string `json:"fri_am_from,omitempty"`

	// Stop staffing hours
	FriAmTo string `json:"fri_am_to,omitempty"`

	// Stop staffing hours
	FriPmFrom string `json:"fri_pm_from,omitempty"`

	// Stop staffing hours
	FriPmTo string `json:"fri_pm_to,omitempty"`

	// Stop staffing hours
	MonAmFrom string `json:"mon_am_from,omitempty"`

	// Stop staffing hours
	MonAmTo string `json:"mon_am_to,omitempty"`

	// Stop staffing hours
	MonPmFrom string `json:"mon_pm_from,omitempty"`

	// Stop staffing hours
	MonPmTo string `json:"mon_pm_to,omitempty"`

	// Stop staffing hours
	PhAdditionalText string `json:"ph_additional_text,omitempty"`

	// Stop staffing hours
	PhFrom string `json:"ph_from,omitempty"`

	// Stop staffing hours
	PhTo string `json:"ph_to,omitempty"`

	// Stop staffing hours
	SatAmFrom string `json:"sat_am_from,omitempty"`

	// Stop staffing hours
	SatAmTo string `json:"sat_am_to,omitempty"`

	// Stop staffing hours
	SatPmFrom string `json:"sat_pm_from,omitempty"`

	// Stop staffing hours
	SatPmTo string `json:"sat_pm_to,omitempty"`

	// Stop staffing hours
	SunAmFrom string `json:"sun_am_from,omitempty"`

	// Stop staffing hours
	SunAmTo string `json:"sun_am_to,omitempty"`

	// Stop staffing hours
	SunPmFrom string `json:"sun_pm_from,omitempty"`

	// Stop staffing hours
	SunPmTo string `json:"sun_pm_to,omitempty"`

	// Stop staffing hours
	ThuAmFrom string `json:"thu_am_from,omitempty"`

	// Stop staffing hours
	ThuAmTo string `json:"thu_am_to,omitempty"`

	// Stop staffing hours
	ThuPmFrom string `json:"thu_pm_from,omitempty"`

	// Stop staffing hours
	ThuPmTo string `json:"thu_pm_to,omitempty"`

	// Stop staffing hours
	TueAmFrom string `json:"tue_am_from,omitempty"`

	// Stop staffing hours
	TueAmTo string `json:"tue_am_to,omitempty"`

	// Stop staffing hours
	TuePmFrom string `json:"tue_pm_from,omitempty"`

	// Stop staffing hours
	TuePmTo string `json:"tue_pm_to,omitempty"`

	// Stop staffing hours
	WedAmFrom string `json:"wed_am_from,omitempty"`

	// Stop staffing hours
	WedAmTo string `json:"wed_am_to,omitempty"`

	// Stop staffing hours
	WedPmTo string `json:"wed_pm_To,omitempty"`

	// Stop staffing hours
	WedPmFrom string `json:"wed_pm_from,omitempty"`
}

V3StopStaffing v3 stop staffing swagger:model V3.StopStaffing

func (*V3StopStaffing) MarshalBinary

func (m *V3StopStaffing) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopStaffing) UnmarshalBinary

func (m *V3StopStaffing) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopStaffing) Validate

func (m *V3StopStaffing) Validate(formats strfmt.Registry) error

Validate validates this v3 stop staffing

type V3StoppingPattern

type V3StoppingPattern struct {

	// Timetabled and real-time service departures
	Departures []*V3Departure `json:"departures"`

	// Directions of travel of route
	Directions map[string]V3Direction `json:"directions,omitempty"`

	// Disruption information applicable to relevant routes or stops
	Disruptions []*V3Disruption `json:"disruptions"`

	// Train lines, tram routes, bus routes, regional coach routes, Night Bus routes
	Routes map[string]V3Route `json:"routes,omitempty"`

	// Individual trips/services of a route
	Runs map[string]V3Run `json:"runs,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// A train station, tram stop, bus stop, regional coach stop or Night Bus stop
	Stops map[string]V3ResultStop `json:"stops,omitempty"`
}

V3StoppingPattern v3 stopping pattern swagger:model V3.StoppingPattern

func (*V3StoppingPattern) MarshalBinary

func (m *V3StoppingPattern) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StoppingPattern) UnmarshalBinary

func (m *V3StoppingPattern) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StoppingPattern) Validate

func (m *V3StoppingPattern) Validate(formats strfmt.Registry) error

Validate validates this v3 stopping pattern

type V3StopsByDistanceResponse

type V3StopsByDistanceResponse struct {

	// Disruption information applicable to relevant routes or stops
	Disruptions map[string]V3Disruption `json:"disruptions,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// Train stations, tram stops, bus stops, regional coach stops or Night Bus stops
	Stops []*V3StopGeosearch `json:"stops"`
}

V3StopsByDistanceResponse v3 stops by distance response swagger:model V3.StopsByDistanceResponse

func (*V3StopsByDistanceResponse) MarshalBinary

func (m *V3StopsByDistanceResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopsByDistanceResponse) UnmarshalBinary

func (m *V3StopsByDistanceResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopsByDistanceResponse) Validate

func (m *V3StopsByDistanceResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 stops by distance response

type V3StopsOnRouteResponse

type V3StopsOnRouteResponse struct {

	// Disruption information applicable to relevant routes or stops
	Disruptions map[string]V3Disruption `json:"disruptions,omitempty"`

	// API Status / Metadata
	Status *V3Status `json:"status,omitempty"`

	// Train stations, tram stops, bus stops, regional coach stops or Night Bus stops
	Stops []*V3StopOnRoute `json:"stops"`
}

V3StopsOnRouteResponse v3 stops on route response swagger:model V3.StopsOnRouteResponse

func (*V3StopsOnRouteResponse) MarshalBinary

func (m *V3StopsOnRouteResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3StopsOnRouteResponse) UnmarshalBinary

func (m *V3StopsOnRouteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3StopsOnRouteResponse) Validate

func (m *V3StopsOnRouteResponse) Validate(formats strfmt.Registry) error

Validate validates this v3 stops on route response

type V3VehicleDescriptor

type V3VehicleDescriptor struct {

	// Indicator if vehicle is air conditioned. May be null. Only available for some tram runs.
	AirConditioned bool `json:"air_conditioned,omitempty"`

	// Vehicle description such as "6 Car Comeng", "6 Car Xtrapolis", "3 Car Comeng", "6 Car Siemens", "3 Car Siemens". May be null/empty.
	//             Only available for some metropolitan train runs.
	Description string `json:"description,omitempty"`

	// Operator identifier of the vehicle such as "26094". May be null/empty. Only available for some tram and bus runs.
	ID string `json:"id,omitempty"`

	// Indicator if vehicle has a low floor. May be null. Only available for some tram runs.
	LowFloor bool `json:"low_floor,omitempty"`

	// Operator name of the vehicle such as "Metro Trains Melbourne", "Yarra Trams", "Ventura Bus Line", "CDC" or "Sita Bus Lines" . May be null/empty.
	//             Only available for train, tram, v/line and some bus runs.
	Operator string `json:"operator,omitempty"`

	// Supplier of vehicle descriptor data.
	// Read Only: true
	Supplier string `json:"supplier,omitempty"`
}

V3VehicleDescriptor v3 vehicle descriptor swagger:model V3.VehicleDescriptor

func (*V3VehicleDescriptor) MarshalBinary

func (m *V3VehicleDescriptor) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3VehicleDescriptor) UnmarshalBinary

func (m *V3VehicleDescriptor) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3VehicleDescriptor) Validate

func (m *V3VehicleDescriptor) Validate(formats strfmt.Registry) error

Validate validates this v3 vehicle descriptor

type V3VehiclePosition

type V3VehiclePosition struct {

	// Compass bearing of the vehicle when known, clockwise from True North, i.e., 0 is North and 90 is East. May be null.
	//             Only available for some bus runs.
	Bearing float32 `json:"bearing,omitempty"`

	// Geographic coordinate of latitude of the vehicle when known. May be null.
	//             Only available for some bus runs.
	Latitude float32 `json:"latitude,omitempty"`

	// Geographic coordinate of longitude of the vehicle when known.
	//             Only available for some bus runs.
	Longitude float32 `json:"longitude,omitempty"`

	// Supplier of vehicle position data.
	// Read Only: true
	Supplier string `json:"supplier,omitempty"`
}

V3VehiclePosition v3 vehicle position swagger:model V3.VehiclePosition

func (*V3VehiclePosition) MarshalBinary

func (m *V3VehiclePosition) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*V3VehiclePosition) UnmarshalBinary

func (m *V3VehiclePosition) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*V3VehiclePosition) Validate

func (m *V3VehiclePosition) Validate(formats strfmt.Registry) error

Validate validates this v3 vehicle position

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL