راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی
این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده است.
مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
list=geosearch (gs)
- این پودمان نیازمند اختیارات خواندن است.
- This module can be used as a generator.
- منبع: GeoData
- مجوز: WTFPL
بازگرداندن صفحاتی که مختصاتی در یک منطقهٔ خاص دارند.
- gscoord
مختصات برای جستجو
قالب: عرض جغرافیایی و طول جغرافیایی با خط عمودی (|) جدا شده‌اند.
- gspage
عنوان صفحه برای جستجو
- gsbbox
Bounding box to search in: pipe (|) separated coordinates of top left and bottom right corners.
- gsradius
شعاع جستجو به متر.
- نوع: عدد صحیح
- The value must be between ۱۰ and ۱۰٬۰۰۰.
- پیش‌فرض: 500
- gsmaxdim
Restrict search to objects no larger than this, in meters.
- نوع: عدد صحیح
- gssort
Set the sort order of returned results.
- distance
- Rank pages by their distance to the center.
- relevance
- Rank pages by their relevance according to CirrusSearch, similar to how Special:Search does it. Currently only supported on wikis that use the ElasticSearch backend, see mw:Extension:GeoData#Search backends.
- یکی از مقدارهای زیر: distance، relevance
- پیش‌فرض: distance
- gslimit
حداکثر تعداد صفحه‌ها برای بازگرداندن.
- نوع: عدد صحیح یا max
- The value must be between ۱ and ۵۰۰.
- پیش‌فرض: 10
- gsglobe
Globe to search on. See mw:Special:MyLanguage/Extension:GeoData#Glossary for details.
- یکی از مقدارهای زیر: earth
- پیش‌فرض: earth
- gsnamespace
فضاهای نامی برای جستجو
- مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15، 100، 101، 102، 103، 710، 711، 828، 829
- برای تعیین همهٔ مقدارها از * استفاده کنید.
- پیش‌فرض: 0
- gsprop
ویژگی‌های اضافی مختصات برای برگرداندن. (ویژگی‌هایی که همواره برگردانده می‌شوند: lat، lon و primary یا secondary بع‌عنوان پرچم بولی.)
- type
- Type of the object the coordinates point to. See mw:Special:MyLanguage/Extension:GeoData#Usage for details.
- name
- نام شی.
- dim
- اندازه حدودی شی به متر.
- country
- ISO 3166-1 alpha-2 country code (e.g. US or RU).
- region
- ISO 3166-2 region code (the part of the ISO 3166-2 code after the dash; e.g. FL or MOS).
- globe
- Which terrestrial body the coordinates are relative to (e.g. moon or pluto). Defaults to Earth. See mw:Special:MyLanguage/Extension:GeoData#Glossary for details.
- مقدارهای (جداشده با | یا جایگزین‌های آن): country، dim، globe، name، region، type
- پیش‌فرض: globe
- gsprimary
نوع مختصات برای بازگرداندن.
- primary
- The location of the subject of the article. There is at most one primary coordinate per title.
- secondary
- The location of some object that's mentioned in the article. Any number of secondary coordinates can be associated with a title.
- all
- Return both primary and secondary coordinates.
- یکی از مقدارهای زیر: all، primary، secondary
- پیش‌فرض: primary
- gsdebug
Whether debug information should be returned.
- نوع: بولی (جزئیات)
- Search around the point with coordinates 37° 47′ 13.1″ N, 122° 23′ 58.84″ W
- api.php?action=query&list=geosearch&gsradius=10000&gscoord=37.786971|-122.399677 [باز کردن در صفحهٔ تمرین]
- Search in a bounding box
- api.php?action=query&list=geosearch&gsbbox=37.8|-122.3|37.7|-122.4 [باز کردن در صفحهٔ تمرین]