نوشتن یک نظر جستجو در نقشه، مختصات جغرافیایی و اطلاعات مکانی عبارت پرس‌وجوی مورد نظر را به شما می‌دهد. برای استفاده از این روش، ۴ پارامتر عبارت پرس‌وجو، شهر (شهری که قصد جستجو در آن را دارید)، شماره صفحه و تعداد نتایج در صفحه به عنوان پارامتر ورودی از شما گرفته و یک سری اطلاعات برحسب موقعیت جغرافیایی و اطلاعات مکانی آن پرس‌وجو به عنوان پارامتر خروجی به شما می‌هد.
توجه: در تمام وب‌سرویس‌های سفارشی پارسی‌جو، اطلاعات ورودی از طریق پارامترها، به شیوه GET یا POST دریافت و خروجی در قالب فرمت JSON برگشت داده می‌شود.
توجه: جهت اعتبارسنجی لازم است رشته api-key دریافت شده را در Header درخواست خود با پارامتر api-key قرار دهید. (راهنمای دریافت API Key) (نحوه ارسال api-key در هدر درخواست)
ساختار ورودی
http(s)://developers.parsijoo.ir/web-service/v1/map/?type=search
نمونه
https://developers.parsijoo.ir/web-service/v1/map/?type=search&q=Searchkey&page=PageNumbers&nrpp=ItemsInPage&city=CityName&extent=YourExtent
پارامترهای ورودی
| مشخصات | نوع متغیر | لزوم استفاده | نام متغیر در پارامتر خروجی | توضیحات |
Searchkey | پرس‌وجو | String | اجباری | q | متن مورد نظر در حالت POST یا GET حتما باید Encode شود |
CityName | شهر | String | اختیاری | y | نام شهری که قصد جستجو در آن را دارید |
YourExtent | محدوده | String | اختیاری | extent | محدوده به صورت مستطیلی بوده که توسط مختصات رئوس یک وتر تعریف می شود. |
PageNumbers | تعداد صفحات نتایج | Integer | اختیاری | page |
|
ItemsInPage | تعداد نتایج در هر صفحه | Integer | اختیاری | nrpp | تعداد نتایج نمایش داده شده در هر صفحه را مشخص نمایید. |
پارامترهای خروجی
مشخصات | نوع | نام متغیر در پارامتر خروجی | توضیحات |
عنوان | String | title |
|
طول جغرافیایی | Double | longitude |
|
عرض جغرافیایی | Double | latitude |
|
G ID | String | gid | آی دی یکتای عارضه بر روی نقشه پارسی جو |
زوم | Integer | zoom | مقادیر زوم از ۳ تا ۱۹ است. |
نوع مکان | String | type | خیابان، کوچه، بانک، مجتمع تجاری و ... |
نام | String | name |
|
آدرس | String | address |
|
تعداد کل نتایج بدست آمده | Integer | resultNumber | تعداد کل نتایجی که با این جستجو به دست آمده را نمایش می دهد. |
لینک صفحه عارضه | String | link | در پارسی جو برای هر عارضه یک صفحه ویژه طراحی شده است که در آن توضیحات بیشتر در مورد عارضه، گالری تصاویر آن عارضه و ... نمایش داده می شود. |
شماره تلفن | Integer | tel | شماره تلفن ثبت شده برای آن عارضه |
تصویر بند انگشتی | String | thumb | در صورت وجود تصویر این پارامتر در خروجی ارسال می شود. تصویر با فرمت Base64 کدگذاری شده است. |
لینک عارضه | String | plink | لینک نمایش عارضه در نقشه پارسی جو با مرکزیت عارضه مورد نظر |
کدهای مربوط به پاسخ درخواست:
200 ارسال و دریافت اطلاعات به خوبی انجام شده است.
400 پارامترها ناقص هستند.
404 متدی با این نام پیدا نشده است.
405 متد فراخوانی Get یا Post اشتباه است.
500 خطا در انجام عملیات، بعدا تلاش کنید.
مثال: جستجوی "خیابان شهید بهشتی" شهر "یزد"
https://developers.parsijoo.ir/web-service/v1/map/?type=search&q=%D8%AE%DB%8C%D8%A7%D8%A8%D8%A7%D9%86%20%D8%B4%D9%87%DB%8C%D8%AF%20%D8%A8%D9%87%D8%B4%D8%AA%DB%8C%20&page=1&nrpp=10&city=%DB%8C%D8%B2%D8%AF&extent=54.22584,31.79576,54.41535,31.97068
توجه: : در مثال فوق عبارت "خیابان شهید بهشتی" به صورت Encode شده در بخش پرس و جو با متغیر “q” به ساختار ورودی ارجاع داده شده است.
شهر مورد جستجو "یزد" تعریف شده که به صورت Encode شده در بخش پرس و جو با متغیر “y” به ساختار ورودی ارجاع داده شده است.
در این مثال 1 صفحه جهت نمایش مد نظراست که با پارامتر page=1 تعریف شده است.
در مثال فوق با استفاده از پارامتر “nrpp=10” در هر صفحه حداکثر 10 نتیجه نمایش داده می شود.
در این مثال رئوس وتر محدوده مستطیل شکل به صورت "extent=54.22584,31.79576,54.41535,31.97068" تعریف شده است. (extent=lat1,long1,lat2,long2)
پاسخ دریافت شده از سرور به صورت زیر است:
{
"reqStatus": {
"statusCode": 200,
"message": null
},
"result":{"resultNumber":1,"items":[{"title":"بلوار شهید ایت الله بهشتی ","longitude":"54.35407839707446","latitude":"31.873618095710377","gid":"o2/JKxU+K04\u003d","zoom":"17","type":"بلوار","name":"شهید ایت الله بهشتی ","address":"شهرستان یزد","link":"https://map.parsijoo.ir/detailpage/بلوار_شهید_ایت_الله_بهشتی_/o2@@JKxU+K04\u003d","tel":"-","plink":"https://map.parsijoo.ir/?lat\u003d31.873618095710377\u0026lon\u003d54.35407839707446\u0026z\u003d17"}]}}
توجه: در پارامتر link، آدرس صفحه ویژه آن عارضه نمایش داده می شود. در این صفحه (در صورت وجود اطلاعات) توضیحات بیشتر در مورد عارضه، تصاویر مختلف از عارضه و ... نمایش داده می شود. برای مثال لینک صفحه ویژه "برج میلاد" را ببینید.
توجه: در html لینک ها به صورت Encode شده نمایش داده می شود برای مثال لینک:
https://map.parsijoo.ir/detailpage/برج_میلاد/5SijCLmuyFM=
به صورت زیر نمایش داده می شود:
https://map.parsijoo.ir/detailpage/برج_میلاد/5SijCLmuyFM\u003d
اما در صورت استفاده در پارامترها، نمایش لینک به صورت صحیح خواهد بود.
