MoroccoAPIقائمة المنارات
معلومة مهمة. قوائم وزارة التجهيز والماء. تُحفظ أسماء المصدر وحقوله باللغة الفرنسية.
فهم الإجابة
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 القديمة أسماء بديلة متوافقة مع السلوك المنشور حالياً، بما فيه تقسيم الصفحات؛ لم يُحدد موعد لحذفها.
حقول الإجابة 9
تشير [] إلى كل عنصر في القائمة. تعني null غير معروف أو غير متاح، ولا تعني صفراً. لغة الدليل لا تترجم قيم المصادر.
dataobject[]النتيجة المطلوبة: كائن واحد أو قائمة.
data[].Nomstringاسم المنارة في المصدر.
data[].Regionstringاسم الجهة في المصدر، وليس رمز MoroccoAPI.
data[].Provincestringاسم الإقليم أو العمالة في المصدر.
data[].Villestringالمدينة المرتبطة بالمنارة في المصدر.
data[].Date de mise en serviceinteger | stringسنة دخول الخدمة أو نصها كما نُشر؛ ليست بالضرورة تاريخ ISO.
data[].Type du pharestringنوع المنارة حسب تصنيف المصدر.
data[].Caracteristique_rythmestringتتابع الومضات الضوئية الذي يساعد الملاحين على تمييز المنارة.
data[].Portee_milenumber | stringمدى الضوء بالأميال البحرية؛ الميل البحري = 1.852 كم. يُحفظ نص المصدر إذا لم يكن رقماً.
بنية البيانات
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"Nom",
"Region",
"Province",
"Ville",
"Date de mise en service",
"Type du phare",
"Caracteristique_rythme",
"Portee_mile"
],
"properties": {
"Nom": {
"type": "string",
"minLength": 1
},
"Region": {
"type": "string",
"minLength": 1
},
"Province": {
"type": "string",
"minLength": 1
},
"Ville": {
"type": "string",
"minLength": 1
},
"Date de mise en service": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"minLength": 1
}
]
},
"Type du phare": {
"type": "string",
"minLength": 1
},
"Caracteristique_rythme": {
"type": "string",
"minLength": 1
},
"Portee_mile": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"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",
"pagination"
],
"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"
}
}
}
},
"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
]
}
]
}
}
}
}
}
}
}المصادر وتقسيم الصفحات 23
metaobjectسياق النتيجة: المصادر والتواريخ والرخصة وتقسيم الصفحات عند الاقتضاء.
meta.datasetstringاسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.
القيم المقبولة:
"morocco-ports""morocco-lighthouses"meta.totalintegerعدد النتائج المطابقة للمرشحات قبل تقسيم الصفحات؛ وليس حجم هذه الصفحة.
meta.licensestringرخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.
القيم المقبولة:
"ODbL-1.0"meta.license_urlstringرابط شروط الرخصة؛ null عند غياب الرابط.
meta.retrieved_atstringتاريخ جلب المشروع لملف المصدر؛ وليس تاريخ رصد البيانات.
meta.source_updated_atstringآخر تحديث معلن من المصدر؛ وليس تاريخ جلب الملف.
meta.transformation_versionstringإصدار قواعد تحويل مجموعة البيانات؛ مستقل عن إصدار الواجهة.
meta.scopestringالنطاق الذي تغطيه البيانات؛ لا يعني تغطية شاملة.
meta.limitationsstring[]القيود المعروفة للمصدر أو التغطية؛ اقرأها قبل استخدام البيانات.
meta.sourcesobject[]المصادر المستخدمة لهذه النتيجة مع الجهات المنتجة والرخص.
meta.sources[].datasetstringاسم مجموعة البيانات الخاصة بالنتيجة أو المصدر.
meta.sources[].producerstringالجهة التي تنشر البيانات الأصلية.
meta.sources[].source_urlstringصفحة نشر المصدر أو التعريف ببياناته.
meta.sources[].resource_urlstringرابط الملف أو المورد المستخدم فعلياً.
meta.sources[].licensestringرخصة إعادة الاستخدام. تعني mixed وجود رخص مختلفة: راجع كل مصدر.
القيم المقبولة:
"ODbL-1.0"meta.sources[].source_updated_atstringآخر تحديث معلن من المصدر؛ وليس تاريخ جلب الملف.
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معرّف هذا الطلب، يفيد عند الإبلاغ عن مشكلة.