Ports et phares/API v2

Un port par nom

GET/api/v2/ports/{name}

À savoir. Listes du ministère de l’Équipement et de l’Eau. Les noms et champs sources sont conservés en français.

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.

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 7

[] 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.Nom du portstring: Nom du port tel que publié ; la clé française est conservée.
data.Type de portsstring: Catégorie de port indiquée dans la source.
data.Connectivitéstring: Indication de connectivité maritime fournie par la source.
data.Latitudenumber: Latitude WGS 84 en degrés décimaux : nord positif, sud négatif.
data.Longitudenumber: Longitude WGS 84 en degrés décimaux : est positif, ouest négatif.
data.Etatstring: État du port décrit dans le fichier source ; pas un suivi en temps réel.

Structure des données

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "Nom du port",
        "Type de ports",
        "Connectivité",
        "Latitude",
        "Longitude",
        "Etat"
      ],
      "properties": {
        "Nom du port": {
          "type": "string",
          "minLength": 1
        },
        "Type de ports": {
          "type": "string",
          "minLength": 1
        },
        "Connectivité": {
          "type": "string",
          "minLength": 1
        },
        "Latitude": {
          "type": "number",
          "minimum": -90,
          "maximum": 90
        },
        "Longitude": {
          "type": "number",
          "minimum": -180,
          "maximum": 180
        },
        "Etat": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "license_url",
        "retrieved_at",
        "source_updated_at",
        "transformation_version",
        "scope",
        "limitations",
        "sources"
      ],
      "properties": {
        "dataset": {
          "type": "string",
          "enum": [
            "morocco-ports",
            "morocco-lighthouses"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "ODbL-1.0"
          ]
        },
        "license_url": {
          "type": "string",
          "format": "uri"
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "source_updated_at": {
          "type": "string",
          "format": "date"
        },
        "transformation_version": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "minLength": 1
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "maxItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string",
                "minLength": 1
              },
              "producer": {
                "type": "string",
                "minLength": 1
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "ODbL-1.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      }
    }
  }
}

Sources et pagination 17

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-ports" "morocco-lighthouses"

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: "ODbL-1.0"

meta.license_urlstring

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

meta.retrieved_atstring

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

meta.source_updated_atstring

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.scopestring

Périmètre couvert par le jeu de données ; ne présume pas une couverture universelle.

meta.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[].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

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

Valeurs acceptées: "ODbL-1.0"

meta.sources[].source_updated_atstring

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

Erreurs

400: Paramètre invalide ou manquant.
404: Ressource introuvable.

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.

Un port par nom

Paramètres

Votre requête