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

Get service announcements and disruption information.

This function retrieves current announcements including service disruptions, schedule changes, construction notices, and other important information affecting public transportation services.

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")
• :names - List of line/station names to filter announcements
• :time_range - Time range object with begin and end times to filter announcements
• :full - Return full announcement details (default: false)
• :filter_planned - Filter planned announcements: "NO_FILTER", "ONLY_PLANNED", "ONLY_UNPLANNED"
• :show_broadcast_relevant - Include broadcast-relevant announcements (default: false)

Examples

# Get all current announcements
{:ok, announcements} = Geofox.Services.Announcements.get_announcements(client)

# Get detailed announcements for specific lines
{:ok, announcements} = Geofox.Services.Announcements.get_announcements(client,
  names: ["U1", "S1", "Bus 112"],
  full: true
)

# Get announcements within a specific time range
time_range = %{
  begin: "2024-01-15T00:00:00+01:00",
  end: "2024-01-15T23:59:59+01:00"
}
{:ok, announcements} = Geofox.Services.Announcements.get_announcements(client,
  time_range: time_range,
  filter_planned: "ONLY_UNPLANNED"
)

Returns

The response includes:

• announcements - List of announcement objects with details like:
  • summary - Brief description of the announcement
  • description - Detailed announcement text
  • locations - Affected lines/stations
  • validities - Time periods when the announcement is valid
  • links - Related URLs for more information
• lastUpdate - Timestamp of the last update