سرویس تعیین محدوده
سرویس تعیین محدوده، محدودهای که موقعیت جغرافیایی مورد نظر در آن قرار دارد را تعیین می‌کند. مختصات جغرافیایی و کد محدوده درخواستی مورد نظر به سرویس ارسال می‌شود و سرویس در پاسخ عنوان و مشخصات محدودهای که موقعیت فوق در آن قرار دارد را برمی‌گرداند. محدوده‌های درخواستی شامل موارد زیر هستند:
محدوده‌های ترافیکی
مناطق شهرداری
محدوده‌های عرفی
محلات کوچک
محدوده‌های بزرگ
ساختار کلی سرویس
get/geocode/geofence?parameters
پارامترهای ورودی
پارامترهای مورد نیاز
| پارامتر | توضیحات |
|---|---|
location |
مختصات جغرافیایی نقطه درخواستی را مشخص می‌کند. طول و عرض جغرافیایی این نقطه با , از هم تفکیک می‌شوند. درهنگام وارد کردن مختصات نقطه درخواستی، ابتدا طول جغرافیایی و سپس عرض جغرافیایی وارد شود. |
geofence_type |
کد محدوده مورد نظر را مشخص می‌کند. محدوده درخواستی شامل مناطق شهرداری، محدوده ترافیکی، محدوده‌های عرفی، محدوده‌های بزرگ و محلات کوچک است که کد آن‌ها به شرح زیر است: کد محدوده‌ه در حال حاضر محدوده‌های ترافیک تنها برای شهرهای تهران، اصفهان و مشهد قابل ارائه است. |
پارامترهای اختیاری
پارامترهای اختیاری آپشن‌ها و امکانات مختلف سرویس را ارائه می‌دهند. ارسال آن‌ها جهت استفاده از سرویس اجباری نیست.
| پارامتر | توضیحات | مقدار پیش‌فرض |
|---|---|---|
request_id |
در صورت ست شدن پارامتر فوق، به صورت یکتا در روز می‌توان برای پیگیری استفاده نمود. | به صورت پیش‌فرض، عدم پیگیری در روز است. |
نمونه درخواست
نمایش محدوده عرفی موقعیت درخواستی
با ارسال مختصات جغرافیایی نقطه درخواستی و کد محدوده مورد نظر، محدودهای که موقعیت فوق در آن واقع شده است در پاسخ برگردانده می‌شود.
https://api.parsimap.ir/geocode/geofence?key=PMI_API_TOKEN&location=51.34203,35.72188&geofence_type=9101
نمونه پاسخ
{
"id": 39100100000027,
"title": "آریا شهر",
"type": "9121",
"status": "OK"
}
پارامترهای خروجی
| پارامتر | توضیحات |
|---|---|
id |
کد محدودهای است که نقطه مورد نظر در آن قرار گرفته است. این کد با توجه به پارامتر ارسال متغیر است و در دو حالت زیر شرح داده شده است: در صورت ارسال کد محدوده ترافیکی، این پارامتر برابر کد محدوده ترافیکی مورد نظر است. زمانی‌که عدد صفر نمایش داده شود نقطه موردنظر در محدوده ترافیکی قرار نگرفته است و در غیر این صورت کد محدوده به شرح جدول زیر نمایش داده می‌شود. جدول در صورت ارسال کد محدوده‌های شهری، این پارامتر کد محدوده شهری مورد نظر است که برابر با کد یکتای آن در سامانه پارسی مپ است. |
title |
نام محدوده درخواستی یافت شده است. |
type |
کد محدوده درخواستی یافت شده است. |
status |
نتیجه درخواست را نشان می‌دهد. برای مثال نتیجه این درخواست OK است که به معنی موفق بودن درخواست است. نتیجه پاسخ به درخواست ارسالی توسط کاربر در قالب جدول زیر ارائه شده است: جدول |