طريقة "PATCH /openapi/v1/user/:userId"

قم بإجراء تغييرات على بيانات المستخدم. نقل موظف في الشركة إلى مجموعة تدريب مختلفة.

طلب

الرأس:

• المصادقة – الرمز المميز لواجهة برمجة التطبيقات الخاصة بالشركة.

المعامل:

• userId – سلسلة نصية – يتم نقل رمز التعريف الخاص بالمستخدم إلى مجموعة مختلفة.

  ويجب أن يستوفي المعايير التالية:

  • الطول 24 حرفًا
  • أحرف صغيرة فقط

مثال على طلب: /openapi/v1/user/1ab2457896abcc1234567891

النص

التنسيق – JSON.‏

• groupId – سلسلة نصة – معرف المجموعة التي سينتقل إليها موظف الشركة.

  يتوافق مع معرف طريقة "/openapi/v1/groups".

  ويجب أن يستوفي المعرف المعايير التالية:

  • الطول 24 حرفًا
  • أحرف صغيرة فقط
• fullName – سلسلة نصية – الاسم الكامل للموظف.
• shortName – سلسلة نصية – الاسم المختصر للموظف.
• email – سلسلة نصية – عنوان البريد الإلكتروني للموظف.

مثال على نص الطلب: { "groupId": "1ab2457896abcc1234567891", fullName : "Marvin John Mims" shortName : "Marvin Mims" email : "mims@mail.com" }

الرد

ملف JSON يحتوي على مصفوفة من البيانات عن كل مستخدم.

• userId – سلسلة نصية – رمز التعريف المعين للمستخدم.
• currentGroup – كائن – مصفوفة من البيانات عن مجموعة المستخدمين الحالية.

  بالتنسيق التالي:

  {

  id,name

  }

  حيث:

  • id – سلسلة نصية – مفتاح تعريف المجموعة الحالية
  • name – سلسلة نصية – اسم المجموعة الحالية.
• previousGroup – كائن – مصفوفة بيانات عن مجموعة المستخدمين السابقة.

  بالتنسيق التالي:

  {

  id,name

  }

  حيث:

  • id – مفتاح المعرف الخاص بالمجموعة السابقة.
  • name – اسم المجموعة السابقة.
• currentFullName – سلسلة نصية – الاسم الكامل الحالي للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى fullName في ملف JSON المصدر.

• previousFullName – سلسلة نصية – الاسم الكامل السابق للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى fullName في ملف JSON المصدر.

• currentShortName – سلسلة نصية – الاسم المختصر الحالي للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى shortName في ملف JSON المصدر.

• currentShortName – سلسلة نصية – الاسم المختصر السابق للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى shortName في ملف JSON المصدر.

• currentEmail – سلسلة نصية – عنوان البريد الإلكتروني الحالي للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى email في ملف JSON المصدر.

• previousEmail – سلسلة نصية – عنوان البريد الإلكتروني السابق للموظف.

  يتم إنشاء المعلمة فقط إذا تمت الإشارة إلى email في ملف JSON المصدر.

  مثال على رد: { userId : "1ab2457896abcc1234567891", "currentGroup" : {id" : "60e050803050c0704080a0e6", "name" : "Rischio ridotto"}, "previousGroup" : {id" : "61e151813151c1714181a1e6", "name" : "Rischio elevato"}, "currentFullName" : "Marvin John Mims", "previousFullName" : "Marvin Jon Mims", "currentShortName" : "Marvin Mims", "previousShortName" : "Marvin", "currentEmail" : "mims@mail.com", "previousEmail" : "johnmims@mail.com" }

الأخطاء المحتملة:

• 200 – success – نجحت العملية.
• 400 – bad request – يوجد خطأ في الطلب ويجب على العميل عدم تكرار الطلب دون إجراء تغييرات
• 400 – user-email-already-exists-in-company – عنوان البريد الإلكتروني هذا مستخدم بالفعل في الشركة
• 401 – common-unauthorized – حدث خطأ في المصادقة.
• 402 – PAYMENT_REQUIRED – الترخيص غير فعال
• 403 – forbidden – لا يحق للرمز المميز استخدام هذه الطريقة
• 404 – لم يتم العثور على المستخدم – تم تمرير عنوان بريد إلكتروني غير صحيح
• 404 – لم يتم العثور على المجموعة – تم تمرير معرف مجموعة غير صحيح
• 409 – حالة المستخدم غير مدعومة لهذه العملية – لا يمكن تنفيذ الطلب؛ لا تسمح حالة المستخدم بإجراء العملية
• 409 – يتم حساب خطة تعليم المستخدم – لا يمكن تنفيذ الطلب لأنه يتم حساب خطة التدريب
• 409 – cannot-join-group – لا يمكن نقل الموظف إلى المجموعة
• 500 – internal-server-error – حدث خطأ داخلي في الخادم.

إلى أعلى الصفحة