État du service

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.

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

État du service ; ok indique que le service répond.

Valeurs acceptées: "ok"

data.servicestring

Nom du service qui répond.

Valeurs acceptées: "MoroccoAPI"

data.versionstring

Version du logiciel, distincte du préfixe de l’API.

data.timestampstring

Date et heure de la réponse, au format ISO 8601.

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "status",
        "service",
        "version",
        "timestamp"
      ],
      "properties": {
        "status": {
          "enum": [
            "ok"
          ]
        },
        "service": {
          "enum": [
            "MoroccoAPI"
          ]
        },
        "version": {
          "type": "string"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "request_id"
      ],
      "properties": {
        "request_id": {
          "type": "string"
        }
      }
    }
  }
}

metaobject

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

meta.request_idstring

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

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