توثيق API بيانات الطلاب

نقطة النهاية الرئيسية (Endpoint)

تعتبر نقطة النهاية (Endpoint) هي الرابط الأساسي الذي يتم من خلاله التفاعل مع الـ API. جميع الطلبات يجب أن توجه إلى هذا الرابط مع تحديد المسار المناسب للعملية المطلوبة.

https://eng-plus.net/settings/all/Marks/api/v1/

العمليات المتاحة

1. جلب بيانات جميع الطلاب

هذه العملية تقوم بإرجاع قائمة كاملة بجميع الطلاب وبياناتهم الأكاديمية. الكائن الرئيسي في الرد يحتوي على مفاتيح تمثل أرقام قيد الطلاب.

GET /

مثال على الرد (عينة مختصرة):

{
    "2405071028": {
        "name": "كمال مثنى أحمد عبيد السـفياني",
        "السنة الأولى": { ... }
    },
    "2405071001": {
        "name": "كريمه حسن عبده علي",
        "السنة الأولى": { ... }
    }
}

2. جلب بيانات طالب محدد

للحصول على بيانات طالب معين، يتم إرسال رقم القيد الخاص به كـ Query Parameter مع الطلب. المعامل يجب أن يكون باسم id.

GET /?id={student_id}

مثال عملي على الطلب:

https://eng-plus.net/settings/all/Marks/api/v1/?id=2405071028

مثال على الرد لطلب ناجح:

{
    "name": "كمال مثنى أحمد عبيد السـفياني",
    "السنة الأولى": {
        "الفصل الأول": {
            "subjects": [
                {"subjectName": "Electric Circuits", "percentage": 94, ...},
                ...
            ],
            "summary": { ... }
        }
    }
}