طلب GET الغرض منه سرد قائمة بالمستخدمين المسجلين، مرتبة حسب اسم المستخدم.
توثيق واجهة برمجة التطبيقات
أعمال التوثيق التالية هي نتاج صفحة Special:ApiHelp/query+allusers، التي ولّدتها آليا نسخة سابقة للإصدار من برمجيات ميدياويكي تعمل على هذا الموقع الشبكي (MediaWiki.org).
#!/usr/bin/python3""" get_allusers.py MediaWiki API Demos Demo of `Allusers` module: Get all users, starting from those whose name begins with the string, 'Drov'. MIT License"""importrequestsS=requests.Session()URL="https://en.wikipedia.org/w/api.php"PARAMS={"action":"query","format":"json","list":"allusers","auprefix":"Drov"}R=S.get(url=URL,params=PARAMS)DATA=R.json()USERS=DATA["query"]["allusers"]foruserinUSERS:print(user["name"])
PHP
<?php/* get_allusers.php MediaWiki API Demos Demo of `Allusers` module: Get all users, starting from those whose name begins with the string, 'Drov'. MIT License*/$endPoint="https://en.wikipedia.org/w/api.php";$params=["action"=>"query","format"=>"json","list"=>"allusers","auprefix"=>"Drov"];$url=$endPoint."?".http_build_query($params);$ch=curl_init($url);curl_setopt($ch,CURLOPT_RETURNTRANSFER,true);$output=curl_exec($ch);curl_close($ch);$result=json_decode($output,true);foreach($result["query"]["allusers"]as$k=>$v){echo($v["name"]."\n");}
JavaScript
/* get_allusers.js MediaWiki API Demos Demo of `Allusers` module: Get all users, starting from those whose name begins with the string, 'Drov'. MIT License*/varurl="https://en.wikipedia.org/w/api.php";varparams={action:"query",format:"json",list:"allusers",auprefix:"Drov"};url=url+"?origin=*";Object.keys(params).forEach(function(key){url+="&"+key+"="+params[key];});fetch(url).then(function(response){returnresponse.json();}).then(function(response){varusers=response.query.allusers;for(varuinusers){console.log(users[u].name);}}).catch(function(error){console.log(error);});
MediaWiki JS
/* get_allusers.js MediaWiki API Demos Demo of `Allusers` module: Get all users, starting from those whose name begins with the string, 'Drov'. MIT License*/varparams={action:'query',format:'json',list:'allusers',auprefix:'Drov'},api=newmw.Api();api.get(params).done(function(data){varusers=data.query.allusers,u;for(uinusers){console.log(users[u].name);}});
الأخطاء المحتملة
الكود
معلومات
augroup-excludegroup
لا يمكن استخدام group و excludegroup معا
تاريخ المتغيرات
v1.12: إضافة auprop=registration
ملاحظات إضافية
إن استدعاء واجهة برمجة التطبيقات هذه يستلزم مطابقة حالة الأحرف، حتى لا تكون نتيجة aufrom=DROV هي ذات نتيجة aufrom=Drov.
تحفظ كافة أسماء المستخدمين المسجلين وتستدعى في صيغة أحرف كبيرة كاملة. لو كنت تستخدم aufrom أو auprefix في استعلامك، تأكد من أنك تقدم لهم قيم تبدأ بمحارف كبيرة الحجم.
رغم أن السبيل المعتاد هو عرض أي مستخدم في قاعدة البيانات، يمكنك أيضا تقييد ردنا إلى مجرد هؤلاء المستخدمين الذين يتمتعون بعضوية مجموعة محددة، مثل إداري النظام أو البوتات. مجموعات المستخدمين هي الكيفية التي تتبعها ميدياويكي في منح المستخدمين حقوق وامتيازات معينة؛ طالع Help:User rights and groups لمزيد من التفاصيل عن كيفية عمل هذا النظام.