ক্লাসরুম এপিআই ত্রুটির তথ্য প্রদান করে, যা ডেভেলপারদের সমস্যা ডিবাগ করতে এবং ব্যবহারকারীদের জন্য সহায়ক ও কার্যকর তথ্য সরবরাহ করতে সাহায্য করে। এই নির্দেশিকায় এপিআই থেকে প্রাপ্ত ত্রুটির তথ্য কীভাবে পার্স করতে হয় তা ব্যাখ্যা করা হয়েছে।
ক্লাসরুম এপিআই দুই স্তরের ত্রুটির তথ্য প্রদান করে:
- হেডারে HTTP ত্রুটি কোড।
- রেসপন্স বডির মধ্যে থাকা একটি অবজেক্ট, যাতে অতিরিক্ত বিবরণ থাকে।
ত্রুটি বার্তার কাঠামো
রেসপন্স বডিতে ফেরত আসা ত্রুটিগুলোতে নিম্নলিখিত ফিল্ডগুলো অন্তর্ভুক্ত থাকে:
-
code: সাংখ্যিক HTTP ত্রুটি কোড। উদাহরণস্বরূপ,403। -
message: ত্রুটি সম্পর্কে অতিরিক্ত বিবরণ। উপলব্ধ থাকলে, ত্রুটির বার্তার শুরুতে@এবং একটি নির্দিষ্ট ত্রুটির ধরণ যুক্ত করা হয়। উদাহরণস্বরূপ,@ClassroomApiDisabled। -
status: HTTP অনুরোধের অবস্থা। উদাহরণস্বরূপ,PERMISSION_DENIEDবাNOT_FOUND।
যদি ClassroomApiDisabled ত্রুটির কারণে কোনো অনুরোধ ব্যর্থ হয়, তাহলে প্রতিক্রিয়াটি হবে:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
আপনি ত্রুটির কারণ ডিবাগ করতে এবং ব্যবহারকারীদের প্রয়োজনীয় তথ্য সরবরাহ করতে রেসপন্স বডি ব্যবহার করতে পারেন। কোনো নির্দিষ্ট ত্রুটির বার্তা পরীক্ষা করার সময়, একই স্ট্রিং দিয়ে শুরু হওয়া অন্যান্য মানের সাথে মিলে যাওয়া এড়াতে বার্তার শেষে একটি স্পেস যোগ করুন। প্রদত্ত ত্রুটির উদাহরণে, ব্যবহারকারীদের কাছে যথাযথ তথ্য উপস্থাপন করার জন্য আপনি পরীক্ষা করতে পারেন যে মেসেজ ফিল্ডটি "@ClassroomApiDisabled " দিয়ে শুরু হয়েছে কিনা।
Classroom API থেকে যে ধরনের ত্রুটিগুলো আসতে পারে, সে সম্পর্কে তথ্যের জন্য Common errors পৃষ্ঠাটি দেখুন।