עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
list=geosearch (gs)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: GeoData
- רישיון: WTFPL
החזרת דפים שיש להם נקודות ציון שנמצאות באזור מסוים.
- gscoord
נקודות ציון שסביבן ייעשה החיפוש.
תסדיק: קו־רוחב וקו־אורך מופרדים בקו ניצב (|).
- gspage
שם הדף שסביבו צריך לחפש.
- gsbbox
תיבת הגבלה שבה ייעשה החיפוש: נקודות ציון מופרדת בקו ניצב (|) של הפינות משמאל למעלה ומימין למטה.
- gsradius
רדיוס חיפוש במטרים.
- סוג: מספר שלם
- הערך חייב להיות בין 10 ל־20,000.
- ברירת המחדל: 500
- gsmaxdim
הגבלת החיפוש לעצמים שאינם גדולים מזה, במטרים.
- סוג: מספר שלם
- gssort
הגדרת סדר המיון של התוצאות המוחזרות.
- distance
- דירוג דפים לפי המרחק שלהם מהמרכז.
- relevance
- דירוג דפים לפי הרלוונטיות שלהם לפי CirrusSearch, בדומה לאיך שהדף Special:Search עושה את זה. כרגע עובד רק באתרי ויקי שמשתמשים בשרת ElasticSearch, ר' mw:Extension:GeoData#Search backends.
- אחד מהערכים הבאים: distance, relevance
- ברירת המחדל: distance
- gslimit
מספר מרבי של דפים להחזיר.
- סוג: מספר שלם או max
- הערך חייב להיות בין 1 ל־500.
- ברירת המחדל: 10
- gsglobe
באיזה כדור לחפש. ר' mw:Special:MyLanguage/Extension:GeoData#Glossary לפרטים.
- אחד מהערכים הבאים: earth
- ברירת המחדל: earth
- gsnamespace
באילו מרחבי שם לחפש.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 108, 109, 110, 111, 710, 711, 828, 829
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת המחדל: 0
- gsprop
אילו מאפייני נקודות ציון להחזיר. (מאפיינים שתמיד מוחזרים: lat, lon, ו־primary או secondary בתור דגל בוליאני.)
- type
- סוג האובייקט שנקודות הציון מפנות אליו. ניתן לעיין בדף mw:Special:MyLanguage/Extension:GeoData#Usage לפרטים נוספים.
- name
- שם האובייקט.
- dim
- הגודל המוערך של האובייקט במטרים.
- country
- קוד המדינה לפי ISO 3166-1 alpha-2 (למשל: US או RU).
- region
- קוד האזור לפי ISO 3166-2 (החלק של קוד ה־ISO 3166-2 שמופיע אחרי המקף, למשל: FL או MOS).
- globe
- הגוף היבשתי שנקודות הציון יחסיות אליו (למשל moon או pluto). ברירת המחדל היא כדור הארץ. אפשר לעיין בדף mw:Special:MyLanguage/Extension:GeoData#Glossary לפרטים נוספים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): country, dim, globe, name, region, type
- ברירת המחדל: globe
- gsprimary
איזה סוג של נקודות ציון להחזיר.
- primary
- מיקום הנושא של הערך. ישנה נקודת ציון ראשית אחת לכל היותר עבור כל כותרת.
- secondary
- המיקום של עצמים מסוימים שמוזכרים בערך. אין הגבלה על מספר נקודות הציון המשניות שניתן לשייך לכל כותרת.
- all
- החזרת נקודות הציון הראשיות והמשניות.
- אחד מהערכים הבאים: all, primary, secondary
- ברירת המחדל: primary
- gsdebug
האם להחזיר מידע לניפוי שגיאות.
- סוג: בוליאני (פרטים)
- לחפש סביב הנקודה שנקודות הציון שלה הן 37° 47′ 13.1″ N, 122° 23′ 58.84″ W
- api.php?action=query&list=geosearch&gsradius=10000&gscoord=37.786971|-122.399677 [פתיחה בארגז חול]
- חיפוש בתיבת הגבלה
- api.php?action=query&list=geosearch&gsbbox=37.8|-122.3|37.7|-122.4 [פתיחה בארגז חול]