עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
list=users (us)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
קבלת מידע על רשימת משתמשים.
פרמטרים:
- usprop
אילו חלקי מידע לקבל:
- blockinfo
- מתייג אם המשתמש חסום, על־ידי מי, ומאיזו סיבה.
- groups
- רשימת כל הקבוצות שהמשתמש שייך אליהן.
- groupmemberships
- לרשום קבוצות שכל משתמש משויך אליהן במפורש, כולל תאריך תפוגה לחברות בכל קבוצה.
- implicitgroups
- רשימת כל הקבוצות שהמשתמש חבר בהן אוטומטית.
- rights
- רשימת כל ההרשאות שיש למשתמש.
- editcount
- הוספת מניין העריכות של המשתמש.
- registration
- הוספת חותם־הזמן של רישום המשתמש.
- emailable
- מתייג אם המשתמש יכול ורוצה לקבל דואר אלקטרוני דרך Special:Emailuser.
- gender
- מתייג את המגדר של המשתמש. מחזיר "male", "female" או "unknown".
- centralids
- הוספת המזהה המרכזי ומצב השיוך למשתמש.
- cancreate
- ציון האם אפשר ליצור חשבון עבור שמות משתמש תקינים, אבל לא רשומים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): blockinfo, cancreate, centralids, editcount, emailable, gender, groupmemberships, groups, implicitgroups, registration, rights
- usattachedwiki
עם usprop=centralids, לציין האם המשתמש משויך לוויקי עם המזהה הזה.
- ususers
רשימת משתמשים שעליהם צריך לקבל מידע.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- ususerids
רשימת מזהי משתמש שעבורם יתקבל המידע.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- ustoken
- מיושן.
יש להשתמש ב־action=query&meta=tokens במקום.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): userrights
דוגמה:
- החזרת מידע עבור המשתמש Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [פתיחה בארגז חול]