REST Resource: networks.lines

  • A Line represents a route operated at a specific frequency, defined by a name and the hubs it visits in sequence.

  • Lines can be created, updated, deleted, and their availability can be managed using dedicated methods.

  • Essential Line data includes its unique identifier (name) and an ordered list of hub identifiers (hubIds[]) indicating the stops along the route.

  • Detailed information and management functionalities for Lines are accessible through the provided REST API endpoints.

Resource: Line

A line that is being operated at a given frequency.

JSON representation
{
  "name": string,
  "hubIds": [
    string
  ]
}
Fields
name

string

Identifier. Cannot be updated.

hubIds[]

string

Required. List of hubs that this line calls at, in the order vehicles stop at them.

Methods

create

Creates a Line.

delete

Deletes a Line.

get

Gets the details of a Line.

list

Lists the Lines.

makeAvailable

Makes a line available.

makeUnavailable

Makes a line unavailable.

patch

Updates a Line.