أمثلة على استخدام واجهة برمجة التطبيقات المفتوحة
مثال 1
تعيد الطريقة خطأ أو رابطًا للمستخدم للوصول إلى بوابة المستخدم إذا كان المستخدم قد بدأ التدريب مسبقًا.
وفي حالة إعادة رابط، يجب عرضه على المستخدم، ولا يتم إجراء أي استدعاءات طريقة أخرى.
وفي جميع الحالات الأخرى، يتم إعادة خطأ برموز مختلفة. ويوجد وصف لقائمة الرموز المتاحة في Swagger وكذلك في الوثائق على الإنترنت.
وفي حالة تلقي خطأ "404 لم يتم العثور على المستخدم"، يتم استدعاء الطريقة رقم 2.
ويعني أي خطأ في الرمز 422 أنه يتم حساب خطة التدريب حاليًا وسيصل الرابط قريبًا. إذا لم يحدث هذا، يجب عليك الاتصال بمسؤول الحساب الذي أصدر ASAP رمز واجهة برمجة التطبيقات المميز له.
مثال 2
في هذه المرحلة، نحصل على قائمة المجموعات التي يستطيع المستخدم إضافة نفسه إليها. بعد أن تتلقى الطريقة القائمة، يجب تصفيتها لعرض تلك المجموعات التي تكون معامل isStarted لها "true".
ويبدأ التدريب في هذه المجموعات فقط، ويمكن للمستخدم الانضمام إلى هذه المجموعات فقط.
في حالة عدم وجود هذه المجموعات، يتم إرجاع الخطأ "404 لم يتم العثور على المجموعات". وفي هذه الحالة، يجب عليك الاتصال بمسؤول الحساب الذي أصدر ASAP الرمز المميز لواجهة برمجة التطبيقات له.
مثال 3
بعد تحديد المجموعة، يتم تمرير البيانات الشخصية ومعرف المجموعة إلى الطريقة رقم 3. وتكون النتيجة إما خطأ أو رد 201 بمعرف المستخدم الذي تمت إضافته. وفي حالة حدوث خطأ، يجب عليك الاتصال بمسؤول الحساب الذي أصدر ASAP الرمز المميز لواجهة برمجة التطبيقات له.
مثال 4
لتلقي بيانات التقرير عن تدريب الموظفين:
- عنوان البريد الإلكتروني المستخدم لتسجيل المستخدم.
- الاسم المختصر المسجل للمستخدم.
- الاسم الكامل المسجل للمستخدم.
- مجموعة التدريب الحالية للمستخدم.
- طول التدريب بالثواني.
- فئة الأداء للدورة الرئيسية.
- فئة الأداء للدورة السريعة.
- حالة التدريب الحالية.
- تقدم التدريب في الدورة الرئيسية كنسبة مئوية بصيغة xx.xx.
- تقدم التدريب في الدورة السريعة كنسبة مئوية بتنسيق xx.xx.
- التاريخ المتوقع لإنهاء الدورة الرئيسية.
- التاريخ المتوقع لإكمال الدورة السريعة.
- تاريخ إكمال الدورة الرئيسية.
- تاريخ إكمال الدورة الرئيسية.
- الدورات التدريبية وحالة التدريب للدورة الرئيسية.
- الدورات التدريبية والحالة التدريب للدورة السريعة.
- تاريخ آخر نشاط بتنسيق يعتمد على لغة ترجمة الإدخال.
- العدد الإجمالي للشهادات التي حصل عليها المستخدم أثناء التدريب.
مثال 5
لنقل المستخدمين بين المجموعات وإنشاء بيانات مجموعة التدريب لكل موظف في الشركة:
- مجموعة التدريب الحالية
- مجموعة التدريب السابقة.
مثال 6
حذف موظف من نظام ASAP.