السدود/API v2

السدود وآخر القياسات

GET/api/v2/dams

معلومة مهمة. رصد تاريخي جزئي، دون بيانات آنية أو استيفاء بين القياسات. يميّز date_basis تاريخ المصدر عن تاريخ عنوان لوحة المعلومات. الحجم: مليون م³؛ نسبة الملء: %.

فهم السياق

مثال توضيحي: تخزين 50 مليون م³ في خزان سعته 100 مليون م³ يعني نسبة ملء 50%. المشاهدات المتاحة تاريخية ولا تغطي جميع السدود.

فهم الإجابة

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

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

meta.pagination: القوائم: 100 نتيجة افتراضياً، و500 كحد أقصى. استخدم limit وoffset؛ تكون meta.pagination.next_offset بقيمة null في الصفحة الأخيرة.

مثال توضيحي: مع limit=10 وoffset=0 تتضمن الصفحة الأولى 10 نتائج على الأكثر. إذا كانت next_offset تساوي 10، اطلب التالية بـoffset=10 والمرشحات نفسها. توقف عندما تصبح next_offset بقيمة null.

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

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

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

dataobject[]

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

data[].idstring

معرّف هذا العنصر في مجموعة البيانات؛ ليس بالضرورة رمزاً رسمياً.

data[].nameobject

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

data[].name.frstring | null

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

data[].name.arstring

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

data[].basinstring

حوض مائي: مساحة تصب مياهها في الشبكة المائية نفسها، وهو مختلف عن الجهة الإدارية.

القيم المقبولة: "bouregreg" "draa-oued-noun" "guir-ziz-gheris" "loukkos" "moulouya" "oum-er-rbia" "sebou" "souss-massa" "tensift"

data[].latest_levelobject

أحدث مشاهدة متاحة في النسخة المحلية؛ ليست قياساً مباشراً.

data[].latest_level.dam_idstring

معرّف السد، يمكن استعماله في /dams/{id}.

data[].latest_level.datestring

التاريخ المدني بصيغة YYYY-MM-DD؛ null إذا كان في انتظار التأكيد.

data[].latest_level.date_basisstring

source_calendar: تاريخ تقويم المصدر؛ dashboard_headline: تاريخ عنوان لوحة البيانات.

القيم المقبولة: "source_calendar" "dashboard_headline"

data[].latest_level.capacity_mm3number | null

سعة الخزان بملايين الأمتار المكعبة (Mm³)؛ null إذا كانت غير معروفة.

data[].latest_level.volume_mm3number

حجم المياه المخزنة بملايين الأمتار المكعبة. 1 Mm³ = 1,000,000 m³.

data[].latest_level.filling_rate_pctnumber

نسبة الملء المئوية: 50 تعني 50% وليس 0.5.

data[].latest_level.previous_year_filling_rate_pctnumber | null

نسبة الملء للسنة السابقة كما وردت في المصدر، أو null.

data[].latest_level.source_idstring

معرّف يربط هذه المشاهدة بمصدر داخل meta.sources.

data[].latest_level.source_refobject

موضع المشاهدة داخل المصدر: ورقة/سطر أو حوض/ترتيب.

data[].latest_level.source_ref.sheetstring

اسم ورقة ملف الجداول المصدر.

data[].latest_level.source_ref.rowinteger

رقم السطر في ملف المصدر، بدءاً من 1.

data[].latest_level.source_ref.basin_codestring

رمز الحوض في لوحة المصدر، وليس رمز HCP.

data[].latest_level.source_ref.dam_indexinteger

ترتيب السد في قائمة حوض المصدر بدءاً من 1؛ ليس معرّفاً ثابتاً.

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

{
  "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
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}

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

metaobject

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

meta.datasetstring

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

القيم المقبولة: "morocco-dams"

meta.totalinteger

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

meta.licensestring

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

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

meta.license_urlnull

رابط شروط الرخصة؛ null عند غياب الرابط.

القيم المقبولة: null

meta.retrieved_atstring

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

meta.source_updated_atstring | null

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

meta.transformation_versionstring

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

meta.coverageobject

النطاق الجغرافي والزمني المتاح فعلياً.

meta.coverage.basinstring | null

حوض مائي: مساحة تصب مياهها في الشبكة المائية نفسها، وهو مختلف عن الجهة الإدارية.

meta.coverage.basinsstring[]

الأحواض التي تغطيها المشاهدات.

meta.coverage.fromstring

بداية الفترة المغطاة أو المطلوبة، وهي مشمولة.

meta.coverage.tostring

نهاية الفترة المغطاة أو المطلوبة، وهي مشمولة.

meta.coverage.real_timeboolean

تعني false أن المشاهدات تاريخية دون تحديث مباشر.

القيم المقبولة: false

meta.coverage.complete_national_coverageboolean

تعني false أن البيانات لا تغطي جميع سدود المغرب.

القيم المقبولة: false

meta.coverage.limitationsstring[]

القيود المعروفة للمصدر أو التغطية؛ اقرأها قبل استخدام البيانات.

meta.sourcesobject[]

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

meta.sources[].idstring

معرّف هذا العنصر في مجموعة البيانات؛ ليس بالضرورة رمزاً رسمياً.

meta.sources[].datasetstring

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

meta.sources[].producerstring

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

meta.sources[].source_urlstring

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

meta.sources[].resource_urlstring

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

meta.sources[].licensestring | null

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

meta.sources[].license_urlstring | null

رابط شروط الرخصة؛ null عند غياب الرابط.

meta.sources[].date_basisstring

source_calendar: تاريخ تقويم المصدر؛ dashboard_headline: تاريخ عنوان لوحة البيانات.

القيم المقبولة: "source_calendar" "dashboard_headline"

meta.sources[].source_updated_atstring | null

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

meta.paginationobject

معلومات لتصفّح نتائج القائمة صفحة بصفحة.

meta.pagination.limitinteger

العدد الأقصى المطلوب في الصفحة: 100 افتراضياً و500 كحد أقصى.

meta.pagination.offsetinteger

عدد النتائج المتجاوزة قبل هذه الصفحة بعد التصفية. تبدأ الصفحة الأولى من 0.

meta.pagination.countinteger

عدد النتائج الموجودة فعلياً في هذه الصفحة.

meta.pagination.has_moreboolean

تكون true إذا بقيت صفحة أخرى من النتائج.

meta.pagination.next_offsetinteger | null

قيمة offset للصفحة التالية؛ null عند النهاية. احتفظ بالمرشحات نفسها.

الأخطاء

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

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

errorobject: تفاصيل الطلب الفاشل؛ تحل محل data وmeta.
error.codestring: رمز ثابت للخطأ، مثل RESOURCE_NOT_FOUND؛ استعمله في منطق التطبيق.
error.messagestring: شرح مقروء للخطأ؛ استعمل code في منطق التطبيق.
error.request_idstring: معرّف هذا الطلب، يفيد عند الإبلاغ عن مشكلة.

السدود وآخر القياسات

المعاملات

طلبك