سرویس آدرس‌یابی معکوس

سرویس آدرس‌یابی معکوس، آدرس یک موقعیت مکانی را تعیین می‌کند. مختصات جغرافیایی یک نقطه به سرویس ارسال می­‌‌شود و سرویس در پاسخ آدرس نوشتاری نقطه درخواستی را برمی‌گرداند. در صورت درخواست کاربر علاوه بر آدرس متنی، آدرس محلی (شناخته شده در سطح محله)، آدرس تقریبی، پلاک، تقسیمات کشوری مربوط به نقطه جغرافیایی، از قبیل استان، شهرستان، بخش، شهر و یا روستا و هم‌چنین محدوده‌ و یا محدوده‌هایی که موقعیت درخواستی در آن قرار دارند را نیز در پاسخ به کاربر ارسال می‌شود.

قابلیت‌های سرویس

تبدیل موقعیت جغرافیایی (یک مکان) به آدرس نوشتاری
تعیین پلاک موقعیت درخواستی
تعیین آدرس محلی موقعیت درخواستی
تعیین آدرس تقریبی موقعیت درخواستی
تعیین محدوده‌ در موقعیت جغرافیایی درخواستی (محدوده‌های ترافیکی، مناطق شهرداری و ...)
تعیین تقسیمات کشوری موقعیت درخواستی

ساختار کلی سرویس

get
/geocode/reverse?parameters

پارامترهای ورودی

پارامترهای مورد نیاز

پارامتر توضیحات
location مختصات جغرافیایی نقطه درخواستی را مشخص می‌کند. طول و عرض جغرافیایی این نقطه با , از هم تفکیک می‌شوند. درهنگام وارد کردن مختصات نقطه درخواستی، ابتدا طول جغرافیایی و سپس عرض جغرافیایی وارد شود.

پارامترهای اختیاری

پارامترهای اختیاری آپشن‌ها و امکانات مختلف سرویس را ارائه می‌دهند. ارسال آن‌ها جهت استفاده از سرویس اجباری نیست.

پارامتر توضیحات مقدار پیش‌فرض
local_address آدرس محلی موقعیت درخواستی را مشخص می‌کند. آدرس محلی به آدرسی گفته می‌شود که شامل بخش‌های انتهایی آدرس کلی و شناخته شده در سطح محله است. به عنوان مثال: خیابان چناران، خیابان سروستان، اواسط بن‌بست بلور آدرس محلی از آدرس کامل شامل باغ فردوس، خیابان فرشته، خیابان چناران، خیابان سروستان، بن‌بست بلوری  است. اگر مقدار این پارامتر true باشد، آدرس محلی تعیین می‌شود. در غیر این صورت اگر مقداری در این پارامتر وارد نشده باشد و یا مقدار آن false باشد، آدرس محلی در پاسخ به سمت کاربر ارسال نمی‌شود. مقدار پیش‌فرض false است.
approx_address آدرس تقریبی موقعیت درخواستی را مشخص می‌کند. آدرس تقریبی، آدرسی است که جزییات محله و کوچه در آن وارد نشده است. این آدرس، شامل بخش‌های ابتدایی آدرس کلی است. به عنوان مثال: باغ فردوس، خیابان فرشته، خیابان چناران آدرس تقریبی از آدرسی کامل شامل باغ فردوس، خیابان فرشته، خیابان چناران، خیابان سروستان، بن‌بست بلوری است. اگر مقدار این پارامتر true باشد، آدرس تقریبی تعیین می‌شود. در غیر این صورت اگر مقداری در این پارامتر وارد نشده باشد و یا مقدار آن false باشد، آدرس تقریبی در پاسخ به سمت کاربر ارسال نمی‌شود. مقدار پیش‌فرض false است.
subdivision تقسیمات سیاسی کشوری مربوط به نقطه درخواستی را مشخص می‌کند. اگر مقدار این پارامتر true باشد، استان، شهرستان، شهر و یا روستایی که نقطه مورد نظر در آن واقع شده است تعیین می‌شوند. در غیر این صورت اگر مقداری در این پارامتر وارد نشده باشد و یا مقدار آن false باشد، تقسیمات کشوری برای نقطه مورد نظر در پاسخ به کاربر ارسال نمی‌شود. مقدار پیش‌فرض false است.
geofence_types محدوده‌هایی که موقعیت درخواستی در آن‌ها قرار دارند را تعیین می‌کند. این محدوده‌ها شامل مناطق شهرداری، محدوده ترافیکی، محدوده‌های عرفی، محدوده‌های بزرگ و محلات کوچک هستند. در صورت ارسال کد محدوده‌های مورد نظر (حداکثر سه محدوده)، محدوده‌های یافت شده در پاسخ ارسال می‌گردند. اگر مقداری برای این پارامتر وارد نشود، محدوده‌ای تعیین نمی‌گردد. کد محدوده‌ها به شرح زیر است:
کد محدوده‌ها
در حال حاضر محدوده‌های ترافیک تنها برای شهرهای تهران، اصفهان و مشهد قابل ارائه است.
مقدار پیش‌فرض، عدم تعیین محدوده است.
request_id در صورت ست شدن پارامتر فوق، به صورت یکتا در روز می‌توان برای پیگیری استفاده نمود. به صورت پیش‌فرض، عدم پیگیری در روز است.

نمونه درخواست

درخواست تبدیل موقعیت جغرافیایی به آدرس نوشتاری

با ارسال مختصات جغرافیایی نقطه درخواستی، آدرس نوشتاری موقعیت مورد نظر در پاسخ برگردانده می‌شود.

https://api.parsimap.ir/geocode/reverse?key=PMI_API_TOKEN&location=51.43401,35.82256&local_address=false&approx_address=false&subdivision=false&plate=false&request_id=false

نمونه پاسخ

{
  "address": "نیاوران، گلاب دره، خ. زبردست شمابی، خ. شکیبایی، ک. پناهی",
  "subdivision_prefix": "تهران",
  "status": "OK"
}

پارامترهای خروجی

پارامتر توضیحات
address آدرس نقطه ارسالی به‌صورت ترکیب پویای بخش‌های آدرس است.
subdivision_prefix پیشوند تقسمات سیاسی کشوری در نقطه مورد نظر است. در صورتیکه نقطه در محدوده  شهری واقع شده باشد، اسم شهر مربوطه است. در غیر این صورت عنوان شهرستانی است که نقطه در آن قرار دارد.
status نتیجه درخواست را نشان می‌دهد. برای مثال نتیجه این درخواست OK است که به معنی موفق بودن درخواست است. نتیجه پاسخ به درخواست ارسالی توسط کاربر در قالب جدول زیر ارائه شده است: جدول

درخواست آدرس محلی

با ارسال مختصات نقطه درخواستی و فعال کردن گزینه local_address، آدرس محلی موقعیت مورد نظر در پاسخ برگردانده می‌شود.

https://api.parsimap.ir/geocode/reverse?key=PMI_API_TOKEN&location=51.43401,35.82256&local_address=true&approx_address=false&subdivision=false&plate=false&request_id=false

نمونه پاسخ

{
  "address": "نیاوران، گلاب دره، خ. زبردست شمابی، خ. شکیبایی، ک. پناهی",
  "subdivision_prefix": "تهران",
  "local_address": "خ. زبردست شمابی، خ. شکیبایی، ابتدای ک. پناهی",
  "status": "OK"
}

پارامترهای خروجی

پارامتر توضیحات
local_address آدرس محلی نقطه ارسالی است.

درخواست آدرس تقریبی

با ارسال مختصات نقطه درخواستی و فعال کردن گزینه approx_address، آدرس تقریبی موقعیت مورد نظر در پاسخ برگردانده می‌شود.

https://api.parsimap.ir/geocode/reverse?key=PMI_API_TOKEN&location=51.43401,35.82256&local_address=false&approx_address=true&subdivision=false&plate=false&request_id=false

نمونه پاسخ

{
  "address": "نیاوران، گلاب دره، خ. زبردست شمابی، خ. شکیبایی، ک. پناهی",
  "subdivision_prefix": "تهران",
  "approximate_address": "نیاوران، گلاب دره، خ. زبردست شمابی",
  "status": "OK"
}

پارامترهای خروجی

پارامتر توضیحات
approximate-address آدرس تقریبی نقطه درخواستی است.

درخواست تعیین محدوده‌

با ارسال مختصات جغرافیایی نقطه درخواستی و کد محدوده مورد نظر، آدرس نوشتاری و محدوده‌ای که موقعیت فوق در آن واقع شده است در پاسخ برگردانده می‌شود.

https://api.parsimap.ir/geocode/reverse?key=PMI_API_TOKEN&location=51.43401,35.82256&local_address=false&approx_address=false&subdivision=false&geofence_types=9101,9100&plate=false&request_id=false

نمونه پاسخ

{
  "address": "نیاوران، گلاب دره، خ. زبردست شمابی، خ. شکیبایی، ک. پناهی",
  "subdivision_prefix": "تهران",
  "geofences": [
    {
      "id": 43100100000021,
      "title": "گلاب دره",
      "type": "9101"
    },
    {
      "id": 32100100000001,
      "title": "شهرداری منطقه یک",
      "type": "9100"
    }
  ],
  "status": "OK"
}

پارامترهای خروجی

پارامتر توضیحات
geofence مشخصات محدوده‌های درخواستی است که شامل بخش‌های زیر است:
  • id: کد محدوده‌‍ای است که نقطه مورد نظر در آن قرار گرفته است. این کد با توجه به پارامتر ارسال متغیر است و در دو حالت زیر شرح داده شده است:
    در صورت ارسال کد محدوده ترافیکی، این پارامتر برابر کد محدوده‌ ترافیکی مورد نظر است. زمانی‌که عدد صفر نمایش داده شود نقطه موردنظر در محدوده ترافیکی قرار نگرفته است و در غیر این صورت کد محدوده به شرح جدول زیر نمایش داده می‌شود. جدول
    در صورت ارسال کد محدوده‌های شهری، این پارامتر کد محدوده‌ شهری مورد نظر است که برابر با کد یکتای آن در سامانه پارسی‌مپ است. .
  • title: نام محدوده مورد یافت شده است.
  • type: کد محدوده درخواستی یافت شده است.

درخواست تقسیمات کشوری

با ارسال مختصات نقطه درخواستی و فعال کردن گزینه subdivision، تقسیمات کشوری در موقعیت مورد نظر در پاسخ برگردانده می‌شود.

https://api.parsimap.ir/geocode/reverse?key=PMI_API_TOKEN&location=51.43401,35.82256&local_address=true&approx_address=true&subdivision=true&plate=false&request_id=false

نمونه پاسخ

{
  "address": "نیاوران، گلاب دره، خ. زبردست شمابی، خ. شکیبایی، ک. پناهی",
  "subdivision_prefix": "تهران",
  "local_address": "خ. زبردست شمابی، خ. شکیبایی، ابتدای ک. پناهی",
  "approximate_address": "نیاوران، گلاب دره، خ. زبردست شمابی",
   "subdivisions": {
    "ostan": {
      "id": 1001,
      "title": "تهران",
      "code": "23",
      "type": "ostan"
    },
    "shahrestan": {
      "id": 100108,
      "title": "شمیرانات",
      "code": "2304",
      "type": "shahrestan"
    },
    "bakhsh": {
      "id": 10410167,
      "title": "رودبارقصران",
      "code": "230401",
      "type": "bakhsh"
    },
    "shahr": {
      "id": 10511133,
      "title": "تهران",
      "code": "2301021576",
      "type": "shahr"
    }
  },
  "status": "OK"
}

پارامترهای خروجی

پارامتر توضیحات
subdivisions تقسیمات سیاسی کشوری در نقطه درخواستی است. این پارامتر شامل چهار بخش‌ استان (ostan)، شهرستان (sharestan)، بخش (bakhsh)، شهر (shahr) و یا روستا (rusta) است. هر بخش نیز شامل موارد زیر است:
  • id: کد تقسیمات کشوری در سامانه پارسی‌مپ برای استان، شهرستان، بخش و شهر است.
  • title: عنوان تقسیمات کشوری شامل استان، شهرستان، بخش، شهر و یا روستا است.
  • code: کد مرکز آمار تقسیمات کشوری برای سطح استان، شهرستان، بخش و شهر است.
  • type: تقسیمات کشوری شامل استان، شهرستان، بخش، شهر و یا روستا است.