حالة الخدمة

data: النتائج المطلوبة، في كائن أو قائمة.

meta: مصادر البيانات ورخصتها وتواريخها. تعني null أن القيمة غير معروفة أو غير متاحة.

API v2 هو المسار المرجعي. تبقى مسارات /api/v1 القديمة أسماء بديلة متوافقة مع السلوك المنشور حالياً، بما فيه تقسيم الصفحات؛ لم يُحدد موعد لحذفها.

تشير [] إلى كل عنصر في القائمة. تعني null غير معروف أو غير متاح، ولا تعني صفراً. لغة الدليل لا تترجم قيم المصادر.

dataobject

النتيجة المطلوبة: كائن واحد أو قائمة.

data.statusstring

حالة الخدمة؛ تعني ok أن الخدمة تستجيب.

القيم المقبولة: "ok"

data.servicestring

اسم الخدمة التي تستجيب.

القيم المقبولة: "MoroccoAPI"

data.versionstring

إصدار البرنامج، وهو مستقل عن إصدار مسار الواجهة.

data.timestampstring

تاريخ الإجابة ووقتها بصيغة 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

سياق النتيجة: المصادر والتواريخ والرخصة وتقسيم الصفحات عند الاقتضاء.

meta.request_idstring

معرّف هذا الطلب، يفيد عند الإبلاغ عن مشكلة.

تتضمن الأخطاء error.code وerror.message وerror.request_id.