Geofox.Core.Lines (geofox_ex v0.1.1)

View Source

Functions for retrieving line information from the Geofox API.

Summary

Functions

List all available lines with optional subline information.

Functions

list_lines(client, opts \\ [])

@spec list_lines(
  Geofox.Client.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

List all available lines with optional subline information.

Parameters

  • client - The Geofox client
  • opts - Optional parameters

Options

  • :language - Language code (default: "de")
  • :version - API version (default: 1)
  • :filter_type - Filter type (default: "NO_FILTER")
  • :with_sublines - Include subline information (default: false)
  • :data_release_id - Data release ID to filter changes since a specific version
  • :modification_types - List of modification types to include (e.g., ["MAIN", "SEQUENCE"])

Examples

# Basic line listing
{:ok, lines} = Geofox.Core.Lines.list_lines(client)

# Include sublines and filter by modification types
{:ok, lines} = Geofox.Core.Lines.list_lines(client,
  with_sublines: true,
  modification_types: ["MAIN", "SEQUENCE"]
)

# Get lines changed since a specific data release
{:ok, lines} = Geofox.Core.Lines.list_lines(client,
  data_release_id: "2024-01-15",
  modification_types: ["MAIN"]
)