Documentation JSON / JSON Documentation

Documentation JSON (Français)

Aperçu

Ce document décrit la structure JSON utilisée pour représenter les statuts des ponts et les informations connexes.

Accès aux données JSON

Les données JSON générées sont disponibles via open data dans le dossier open_data :

• /open_data/live.json : flux en temps réel des statuts des ponts.
• /open_data/daily_risk_calculator/profil_hebdo_YYYY-MM-DD.json : profils hebdomadaires de risque, un fichier par date.

Structure de live.json

Le fichier live.json se compose de :

• generation_time : date et heure de génération, au format ISO 8601/RFC 3339.
• data : tableau d’objets, chacun représentant un pont, avec :
• bridge_name : nom du pont (Chaîne).
• status : tableau de chaînes indiquant l’état ("Available", "Unavilable", "Raising soon", "Lowering").
• details : tableau d’objets, un par navire à venir :
• description : type de navire ("Commercial vessel", "Pleasure craft").
• eta : heure estimée d’arrivée (HH:MM, Chaîne).
• time_left : minutes restantes avant arrivée (Entier).
• is_estimate : true si l’ETA est estimée (Boolean).

Exemple de live.json

{
  "generation_time": "2024-08-25T16:36:15.123456-04:00",
  "data": [
    {
      "bridge_name": "St-Louis-de-Gonzague Bridge",
      "status": ["Available"],
      "details": [
        {
          "description": "Commercial vessel",
          "eta": "20:59*",
          "time_left": "253",
          "is_estimate": true
        }
      ]
    },
    {
      "bridge_name": "Larocque Bridge",
      "status": ["Available"],
      "details": [
        {
          "description": "Pleasure craft",
          "eta": "21:16",
          "time_left": 280,
          "is_estimate": false
        }
      ]
    }
  ]
}

Profil de risque quotidien

Chaque fichier profil_hebdo_YYYY-MM-DD.json contient :

• generated : date/heure UTC de génération (RFC 3339).
• ponts : objet dont chaque clé est l’identifiant d’un pont (larocque, st_louis_de_gonzague, etc.) et dont la valeur détaille la semaine à venir :
• Clés des jours en français (dimanche…samedi).
• Pour chaque jour, objet avec créneaux de 15 min (HH:MM) → valeur décimale [0–1] ( 0=0 %, 1=100 %).

Exemple de profil_hebdo_2025-05-14.json

{
  "generated": "2025-05-14T00:01:00.253008Z",
  "ponts": {
    "larocque": {
      "dimanche": {
        "00:00": 0.3333,
        "00:15": 0.5,
        "00:30": 0.1667,
        "00:45": 0.0,
        "...": "..."
      },
      "lundi": { /* ... */ },
      /* ... autres jours ... */
    },
    "st_louis_de_gonzague": { /* même structure */ }
  }
}

JSON Documentation (English)

Overview

This document describes the JSON structure used to represent bridge statuses and related information.

Accessing JSON Data

All JSON outputs are available as open data under open_data:

• /open_data/live.json: live feed of bridge statuses.
• /open_data/daily_risk_calculator/profil_hebdo_YYYY-MM-DD.json: weekly risk profiles generated daily (one file per date).

Live Feed live.json

The live.json file consists of:

• generation_time: timestamp when generated (ISO 8601/RFC 3339).
• data: array of bridge objects, each with:
• bridge_name: name (String).
• status: array of status strings (“Available”, “Unavailable”, “Raising soon”, “Lowering”).
• details: array of upcoming vessel objects:
• description: vessel type (“Commercial Vessel”, “Pleasure Craft”).
• eta: estimated arrival time (HH:MM, String).
• time_left: minutes until arrival (Integer).
• is_estimate: true if ETA is estimated (Boolean).

Example live.json

{
  "generation_time": "2024-08-25T16:36:15.123456-04:00",
  "data": [
    {
      "bridge_name": "St-Louis-de-Gonzague Bridge",
      "status": ["Available"],
      "details": [
        {
          "description": "Commercial Vessel",
          "eta": "20:59*",
          "time_left": 263,
          "is_estimate": true
        }
      ]
    },
    {
      "bridge_name": "Larocque Bridge",
      "status": ["Available"],
      "details": [
        {
          "description": "Pleasure Craft",
          "eta": "21:16",
          "time_left": 280,
          "is_estimate": false
        }
      ]
    }
  ]
}

Daily Risk Profile

Each profil_hebdo_YYYY-MM-DD.json file contains:

• generated: UTC generation timestamp (RFC 3339).
• ponts: object mapping bridge IDs to their upcoming-week profile:
• Keys are days of the week in French (dimanche…samedi).
• Each day maps 15-minute slots (HH:MM) to a decimal risk [0–1].

Example profil_hebdo_2025-05-14.json

{
  "generated": "2025-05-14T23:17:00.253008Z",
  "ponts": {
    "larocque": {
      "dimanche": {
        "00:00": 0.3333,
        "00:15": 0.5,
        "00:30": 0.1667,
        "00:45": 0.0,
        "...": "..."
      },
      "lundi": { /* ... */ },
      /* ... other days ... */
    },
    "st_louis_de_gonzague": { /* same structure */ }
  }
}