MoroccoAPIDocumentation
v2.3.0Code source
Référence API

Choisissez une ressource. Ajustez les paramètres. Essayez.

Sans clé APIRéponses JSONCORS ouvert
Barrages/API v2

Barrages et dernier relevé

GET/api/v2/dams

À savoir. Observations historiques partielles, pas de données en temps réel ni d’interpolation. date_basis distingue la date source de la date affichée par le tableau de bord. Volume : millions de m³ ; remplissage : %.

Comprendre le contexte

Exemple illustratif : 50 Mm³ stockés pour une capacité de 100 Mm³ correspondent à un remplissage de 50 %. Les observations disponibles sont historiques, et ne couvrent pas tous les barrages.

Paramètres

03
stringFacultatif · Filtre

Identifiant du bassin versant, repris depuis la liste des barrages.

1-100 caractères
Format^[a-z0-9]+(?:-[a-z0-9]+)*$
integerFacultatif · Filtre

Résultats par page. 100 par défaut, 500 maximum.

Minimum: 1Maximum: 500Par défaut: 100
integerFacultatif · Filtre

Résultats à ignorer après filtrage. Commence à 0.

Minimum: 0Maximum: 2147483647Par défaut: 0
Comprendre la réponse

data: Les résultats demandés, sous forme d’objet ou de liste.

meta: Sources, licence et dates du jeu de données. null signifie une valeur inconnue ou indisponible.

meta.pagination: Listes : 100 résultats par défaut, 500 maximum. Utilisez limit et offset ; meta.pagination.next_offset vaut null à la dernière page.

Exemple illustratif: Avec limit=10 et offset=0, la première page contient au plus 10 résultats. Si next_offset vaut 10, demandez la suivante avec offset=10 et les mêmes filtres. Arrêtez quand next_offset vaut null.

API v2 est le chemin de référence. Les anciens chemins /api/v1 restent des alias de compatibilité du comportement actuellement publié, pagination comprise ; aucune date de suppression n’est fixée.

Champs renvoyés 20

[] désigne chaque élément d’une liste. null signifie inconnu ou indisponible, jamais zéro. La langue du guide ne traduit pas les valeurs des sources.

dataobject[]

Résultat demandé : objet unique ou liste.

data[].idstring

Identifiant de cet élément dans le jeu de données ; pas nécessairement un code officiel.

data[].nameobject

Nom de la ressource, éventuellement réparti par langue.

data[].name.frstring | null

Valeur en français ; null si aucune traduction n’est fournie.

data[].name.arstring

Valeur en arabe ; null si aucune traduction n’est fournie.

data[].basinstring

Bassin hydraulique : territoire dont les eaux alimentent un même réseau, distinct d’une région administrative.

Valeurs acceptées: "bouregreg" "draa-oued-noun" "guir-ziz-gheris" "loukkos" "moulouya" "oum-er-rbia" "sebou" "souss-massa" "tensift"

data[].latest_levelobject

Observation la plus récente disponible dans la copie locale ; pas une mesure en direct.

data[].latest_level.dam_idstring

Identifiant du barrage, réutilisable dans /dams/{id}.

data[].latest_level.datestring

Date civile au format AAAA-MM-JJ ; null si elle attend confirmation.

data[].latest_level.date_basisstring

source_calendar : date du calendrier source ; dashboard_headline : date de l’en-tête du tableau de bord.

Valeurs acceptées: "source_calendar" "dashboard_headline"

data[].latest_level.capacity_mm3number | null

Capacité du réservoir en millions de mètres cubes (Mm³) ; null si inconnue.

data[].latest_level.volume_mm3number

Volume d’eau stockée en millions de mètres cubes. 1 Mm³ = 1 000 000 m³.

data[].latest_level.filling_rate_pctnumber

Taux de remplissage en pourcentage : 50 signifie 50 %, pas 0,5.

data[].latest_level.previous_year_filling_rate_pctnumber | null

Taux de remplissage de l’année précédente indiqué par la source, ou null.

data[].latest_level.source_idstring

Identifiant permettant de retrouver la source dans meta.sources.

data[].latest_level.source_refobject

Repère de l’observation dans la source : feuille/ligne ou bassin/index.

data[].latest_level.source_ref.sheetstring

Nom de la feuille du tableur source.

data[].latest_level.source_ref.rowinteger

Numéro de ligne du tableur source, commençant à 1.

data[].latest_level.source_ref.basin_codestring

Code du bassin dans la source du tableau de bord, pas un code HCP.

data[].latest_level.source_ref.dam_indexinteger

Position du barrage dans la liste du bassin source, à partir de 1 ; pas un identifiant stable.

Structure des données
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "basin",
          "latest_level"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100,
            "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
          },
          "name": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "fr"
            ],
            "properties": {
              "fr": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "ar": {
                "type": "string"
              }
            }
          },
          "basin": {
            "type": "string",
            "enum": [
              "bouregreg",
              "draa-oued-noun",
              "guir-ziz-gheris",
              "loukkos",
              "moulouya",
              "oum-er-rbia",
              "sebou",
              "souss-massa",
              "tensift"
            ]
          },
          "latest_level": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dam_id",
              "date",
              "date_basis",
              "capacity_mm3",
              "volume_mm3",
              "filling_rate_pct",
              "source_id",
              "source_ref"
            ],
            "properties": {
              "dam_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
              },
              "date": {
                "type": "string",
                "format": "date"
              },
              "date_basis": {
                "type": "string",
                "enum": [
                  "source_calendar",
                  "dashboard_headline"
                ]
              },
              "capacity_mm3": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "volume_mm3": {
                "type": "number",
                "minimum": 0
              },
              "filling_rate_pct": {
                "type": "number",
                "minimum": 0
              },
              "previous_year_filling_rate_pct": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "source_id": {
                "type": "string"
              },
              "source_ref": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "sheet",
                      "row"
                    ],
                    "properties": {
                      "sheet": {
                        "type": "string"
                      },
                      "row": {
                        "type": "integer",
                        "minimum": 1
                      }
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "basin_code",
                      "dam_index"
                    ],
                    "properties": {
                      "basin_code": {
                        "type": "string",
                        "pattern": "^MH[1-9]$"
                      },
                      "dam_index": {
                        "type": "integer",
                        "minimum": 1
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "license_url",
        "retrieved_at",
        "source_updated_at",
        "transformation_version",
        "coverage",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "morocco-dams"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "mixed"
          ]
        },
        "license_url": {
          "type": "string",
          "nullable": true,
          "enum": [
            null
          ]
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "source_updated_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "transformation_version": {
          "type": "string"
        },
        "coverage": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "basin",
            "basins",
            "from",
            "to",
            "real_time",
            "complete_national_coverage",
            "limitations"
          ],
          "properties": {
            "basin": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "bouregreg",
                    "draa-oued-noun",
                    "guir-ziz-gheris",
                    "loukkos",
                    "moulouya",
                    "oum-er-rbia",
                    "sebou",
                    "souss-massa",
                    "tensift"
                  ]
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            },
            "basins": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "bouregreg",
                  "draa-oued-noun",
                  "guir-ziz-gheris",
                  "loukkos",
                  "moulouya",
                  "oum-er-rbia",
                  "sebou",
                  "souss-massa",
                  "tensift"
                ]
              }
            },
            "from": {
              "type": "string",
              "format": "date"
            },
            "to": {
              "type": "string",
              "format": "date"
            },
            "real_time": {
              "enum": [
                false
              ]
            },
            "complete_national_coverage": {
              "enum": [
                false
              ]
            },
            "limitations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "license_url",
              "date_basis",
              "source_updated_at"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "anyOf": [
                  {
                    "enum": [
                      "ODbL-1.0"
                    ]
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "license_url": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "date_basis": {
                "type": "string",
                "enum": [
                  "source_calendar",
                  "dashboard_headline"
                ]
              },
              "source_updated_at": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          }
        },
        "pagination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "limit",
            "offset",
            "count",
            "has_more",
            "next_offset"
          ],
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500
            },
            "offset": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "has_more": {
              "type": "boolean"
            },
            "next_offset": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}
Sources et pagination 32
metaobject

Contexte du résultat : sources, dates, licence et pagination si applicable.

meta.datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

Valeurs acceptées: "morocco-dams"

meta.totalinteger

Nombre de résultats correspondant aux filtres, avant pagination ; pas la taille de cette page.

meta.licensestring

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

Valeurs acceptées: "mixed"

meta.license_urlnull

Lien vers les conditions de la licence ; null si aucune URL n’est fournie.

Valeurs acceptées: null

meta.retrieved_atstring

Date de récupération du fichier source par le projet ; pas la date des observations.

meta.source_updated_atstring | null

Dernière mise à jour annoncée par la source ; pas la date de récupération.

meta.transformation_versionstring

Version des règles de conversion du jeu de données ; distincte de l’API.

meta.coverageobject

Périmètre géographique et temporel effectivement disponible.

meta.coverage.basinstring | null

Bassin hydraulique : territoire dont les eaux alimentent un même réseau, distinct d’une région administrative.

meta.coverage.basinsstring[]

Liste des bassins couverts par les observations.

meta.coverage.fromstring

Début de la période couverte ou demandée, inclus.

meta.coverage.tostring

Fin de la période couverte ou demandée, incluse.

meta.coverage.real_timeboolean

false : les observations sont historiques, sans mise à jour en direct.

Valeurs acceptées: false

meta.coverage.complete_national_coverageboolean

false : le jeu de données ne couvre pas tous les barrages du Maroc.

Valeurs acceptées: false

meta.coverage.limitationsstring[]

Limites connues de la source ou de la couverture ; à lire avant d’utiliser les données.

meta.sourcesobject[]

Sources utilisées pour ce résultat, avec leurs producteurs et licences.

meta.sources[].idstring

Identifiant de cet élément dans le jeu de données ; pas nécessairement un code officiel.

meta.sources[].datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

meta.sources[].producerstring

Organisme qui publie la donnée originale.

meta.sources[].source_urlstring

Page de présentation ou de publication de la source.

meta.sources[].resource_urlstring

Lien vers le fichier ou la ressource utilisée.

meta.sources[].licensestring | null

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

meta.sources[].license_urlstring | null

Lien vers les conditions de la licence ; null si aucune URL n’est fournie.

meta.sources[].date_basisstring

source_calendar : date du calendrier source ; dashboard_headline : date de l’en-tête du tableau de bord.

Valeurs acceptées: "source_calendar" "dashboard_headline"

meta.sources[].source_updated_atstring | null

Dernière mise à jour annoncée par la source ; pas la date de récupération.

meta.paginationobject

Informations pour parcourir une collection page par page.

meta.pagination.limitinteger

Nombre maximal demandé par page : 100 par défaut, 500 au maximum.

meta.pagination.offsetinteger

Nombre de résultats ignorés avant cette page, après filtrage. La première page commence à 0.

meta.pagination.countinteger

Nombre de résultats effectivement présents dans cette page.

meta.pagination.has_moreboolean

true s’il reste une autre page de résultats.

meta.pagination.next_offsetinteger | null

Valeur de offset pour la page suivante ; null à la fin. Gardez les mêmes filtres.

Erreurs
  • 400: Paramètre invalide ou manquant.

Les erreurs renvoient error.code, error.message et error.request_id.

errorobject

Détails d’une requête échouée ; remplace data et meta.

error.codestring

Code stable de l’erreur, par exemple RESOURCE_NOT_FOUND ; à utiliser dans votre logique.

error.messagestring

Explication lisible de l’erreur ; utilisez code pour la logique de votre application.

error.request_idstring

Identifiant du traitement de cette requête, utile pour retrouver un problème.

Votre requête

GET · JSON

URL de base

Réponse
La réponse réelle s’affichera ici.
La langue change le guide, pas les clés JSON ni les valeurs des sources.