سرویس تعیین تقسیمات کشوری

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

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

get
/geocode/subdivision?parameters

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

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

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

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

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

پارامتر	توضیحات	مقدار پیش‌فرض
`request_id`	در صورت ست شدن پارامتر فوق، به صورت یکتا در روز می‌توان برای پیگیری استفاده نمود.	به صورت پیش‌فرض، عدم پیگیری در روز است.

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

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

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

https://api.parsimap.ir/geocode/subdivision?key=PMI_API_TOKEN&location=51.37533,35.68869

نمونه پاسخ

{
  "ostan": {
    "id": 1001,
    "title": "تهران",
    "code": "23",
    "type": "ostan"
  },
  "shahrestan": {
    "id": 100101,
    "title": "تهران",
    "code": "2301",
    "type": "shahrestan"
  },
  "bakhsh": {
    "id": 10410151,
    "title": "مرکزی",
    "code": "230102",
    "type": "bakhsh"
  },
  "shahr": {
    "id": 10511133,
    "title": "تهران",
    "code": "2301021576",
    "type": "shahr"
  },
  "status": "OK"
}

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

پارامتر	توضیحات
`ostan`	اطلاعات استانی است که نقطه مورد نظر در آن واقع شده اسد. شامل بخش‌های زیر است: id: کد تقسیمات کشوری سامانه پارسی‌مپ در سطح استان است. title: عنوان استانی است که نقطه مورد نظر در آن واقع شده است. code: کد مرکز آمار تقسیمات کشوری در سطح استان است. type: تقسیمات کشوری استان است.
`shahrestan`	اطلاعات شهرستانی است که نقطه مورد نظر در آن واقع شده است. شامل بخش‌های زیر است: id: کد تقسیمات کشوری سامانه پارسی مپ در سطح شهرستان است. title: عنوان شهرستانی است که نقطه مورد نظر در آن واقع شده است. code: کد مرکز آمار تقسیمات کشوری در سطح شهرستان است. type: تقسیمات کشوری شهرستان است.
`bakhsh`	اطلاعات بخشی است که نقطه مورد نظر در آن واقع شده است. شامل بخش‌های زیر است: id: کد تقسیمات کشوری سامانه پارسی مپ در سطح بخش است. title: عنوان بخشی است که نقطه مورد نظر در آن واقع شده است. code: کد مرکز آمار تقسیمات کشوری در سطح بخش است. type: تقسیمات کشوری بخش است.
`shahr`	اطلاعات شهر و یا روستایی است که نقطه مورد نظر در آن واقع شده است. شامل بخش‌های زیر است: id: کد تقسیمات کشوری سامانه پارسی مپ در سطح شهر و یا روستا است. title: عنوان شهر و یا روستایی است که نقطه مورد نظر در آن واقع شده است. code: کد مرکز آمار تقسیمات کشوری در سطح شهر و یا روستا است. type: تقسیمات کشوری شهر و یا روستا است.
`status`	نتیجه درخواست را نشان می‌دهد. برای مثال نتیجه این درخواست `OK` است که به معنی موفق بودن درخواست است. نتیجه پاسخ به درخواست ارسالی توسط کاربر در قالب جدول زیر ارائه شده است: جدول