ClientSettingsData

public struct ClientSettingsData : Content

Publicly available configuration information about the current cruise/sailing. This endpoint allows client apps to fetch environment configuration rather than hardcoding values.

Returned by: GET /api/v3/client/settings

Show on GitHub

  • Canonical hostnames for the Twitarr server (e.g., “twitarr.com”, “joco.hollandamerica.com”)

    Declaration

    Swift

    var canonicalHostnames: [String]
    Show on GitHub

  • The date the cruise embarks, at midnight in the port time zone

    Declaration

    Swift

    var cruiseStartDate: Date
    Show on GitHub

  • Length of the cruise in days, including partial days (embarkation through disembarkation)

    Declaration

    Swift

    var cruiseLengthInDays: Int
    Show on GitHub

  • The Foundation TimeZone identifier for the port of departure (e.g., “America/New_York”)

    Declaration

    Swift

    var portTimeZoneID: String
    Show on GitHub

  • The abbreviation for the port time zone (e.g., “EST”, “EDT”)

    Declaration

    Swift

    var portTimeZoneAbbrev: String
    Show on GitHub

  • Seconds from GMT for the port time zone

    Declaration

    Swift

    var portTimeZoneOffset: Int
    Show on GitHub

  • URL used for automated schedule updates (typically a sched.com iCalendar URL)

    Declaration

    Swift

    var scheduleUpdateURL: String
    Show on GitHub

  • The name of the shipboard Wifi network

    Declaration

    Swift

    var shipWifiSSID: String?
    Show on GitHub

  • If TRUE, users can create accounts, log in, and edit their profile before the cruise in a restricted pre-registration mode.

    Declaration

    Swift

    var enablePreregistration: Bool
    Show on GitHub

  • Unique identifier for this Postgres database installation (from pg_control_system())

    Declaration

    Swift

    var installationID: String
    Show on GitHub

Username Validation