التقسيم الإداري/API v2

بيانات جهة

GET/api/v2/regions/{code}

معلومة مهمة. مرجع المندوبية السامية للتخطيط: الجهات والأقاليم والجماعات. الرموز معرّفات خاصة بـMoroccoAPI.

فهم السياق

تضم الجهة أقاليم وعمالات، وتضم هذه جماعات حضرية أو قروية. بعض الجماعات مقسّمة إلى مقاطعات. مثلاً: الدار البيضاء جماعة داخل جهة الدار البيضاء-سطات؛ والمقاطعة ليست جهة. HCP هي المندوبية السامية للتخطيط، وRGPH هو الإحصاء العام للسكان والسكنى.

فهم الإجابة

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

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

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

حقول الإجابة 8

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

dataobject

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

data.codestring

معرّف المورد في MoroccoAPI؛ استعمله في روابط المورد المناسبة.

مثال توضيحي: جهة الرباط-سلا-القنيطرة: code = "rabat-sale-kenitra" وhcp_code = "04". يحددان الجهة نفسها في نظامين مختلفين.

data.hcp_codestring

رمز المندوبية السامية للتخطيط، جهاز الإحصاء المغربي. احتفظ به كنص للحفاظ على الأصفار الأولى.

data.typestring

نوع المورد. تظهر القيم الممكنة أسفله.

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

data.nameobject

اسم المورد، وقد يكون موزّعاً حسب اللغة.

data.name.arstring

القيمة بالعربية؛ null عند غياب الترجمة.

data.name.frstring

القيمة بالفرنسية؛ null عند غياب الترجمة.

data.name.enstring

القيمة بالإنجليزية؛ null عند غياب الترجمة.

بنية البيانات

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code",
        "hcp_code",
        "type",
        "name"
      ],
      "properties": {
        "code": {
          "type": "string"
        },
        "hcp_code": {
          "type": "string",
          "pattern": "^[0-9]{2}$"
        },
        "type": {
          "enum": [
            "region"
          ]
        },
        "name": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ar",
            "fr",
            "en"
          ],
          "properties": {
            "ar": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "en": {
              "type": "string"
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "administrative-regions"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "CC-BY-4.0"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-09-25"
          ]
        },
        "transformation_version": {
          "enum": [
            "2.0.0"
          ]
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "CC-BY-4.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      }
    }
  }
}

المصادر وتقسيم الصفحات 13

metaobject

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

meta.datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

القيم المقبولة: "administrative-regions"

meta.totalinteger

عدد النتائج المطابقة للمرشحات قبل تقسيم الصفحات؛ وليس حجم هذه الصفحة.

meta.licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "CC-BY-4.0"

meta.retrieved_atstring

تاريخ جلب المشروع لملف المصدر؛ وليس تاريخ رصد البيانات.

القيم المقبولة: "2026-09-25"

meta.transformation_versionstring

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

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

meta.sourcesobject[]

المصادر المستخدمة لهذه النتيجة مع الجهات المنتجة والرخص.

meta.sources[].datasetstring

اسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.

meta.sources[].producerstring

الجهة التي تنشر البيانات الأصلية.

meta.sources[].source_urlstring

صفحة نشر المصدر أو التعريف ببياناته.

meta.sources[].resource_urlstring

رابط الملف أو المورد المستخدم فعلياً.

meta.sources[].licensestring

رخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.

القيم المقبولة: "CC-BY-4.0"

meta.sources[].source_updated_atstring

آخر تحديث معلن من المصدر؛ وليس تاريخ جلب الملف.

الأخطاء

400: معامل غير صالح أو مفقود.
404: المورد غير موجود.

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

errorobject

تفاصيل الطلب الفاشل؛ تحل محل data وmeta.

error.codestring

رمز ثابت للخطأ، مثل RESOURCE_NOT_FOUND؛ استعمله في منطق التطبيق.

مثال توضيحي: جهة الرباط-سلا-القنيطرة: code = "rabat-sale-kenitra" وhcp_code = "04". يحددان الجهة نفسها في نظامين مختلفين.

error.messagestring

شرح مقروء للخطأ؛ استعمل code في منطق التطبيق.

error.request_idstring

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

بيانات جهة

المعاملات

طلبك