gis-tools-ts - v0.6.0
    Preparing search index...

    Interface GBFSSystem

    System Definition that is returned from the github CSV file.

    interface GBFSSystem {
        authInfo?: string;
        autoDiscoveryUrl: string;
        countryCode: string;
        location: string;
        name: string;
        supportedVersions: string[];
        systemId: string;
        url: string;
    }
    Index

    Properties

    authInfo? autoDiscoveryUrl countryCode location name supportedVersions systemId url

    Properties

    authInfo?: string

    [Conditionally Required] If authentication is required, this MUST contain a URL to a human-readable page describing how the authentication should be performed and how credentials can be created, or directly contain the public key-value pair to append to the feed URLs.

    autoDiscoveryUrl: string

    [Required] URL for the system's gbfs.json auto-discovery file.

    countryCode: string

    [Required] ISO 3166-1 alpha-2 code designating the country where the system is located.

    location: string

    [Required] Primary city in which the system is located, followed by the 2-letter state code for US systems. The location name SHOULD be in English if the location has an English name (eg: Brussels).

    name: string

    [Required] Name of the mobility system. This MUST match the name field in system_information.json

    supportedVersions: string[]

    [Required] List of GBFS version(s) under which the feed is published. Multiple values are separated by a semi-colon surrounded with 1 space on each side for readability (" ; ").

    systemId: string

    [Required] ID for the system. This MUST match the system_id field in system_information.json.

    url: string

    [Required] URL for the system from the url field in system_information.json. If the url field is not included in system_information.json this SHOULD be the primary URL for the system operator.

    Settings

    Member Visibility

    On This Page

    Properties