API Reference

این مرجع API بر اساس نوع منبع سازماندهی شده است. هر نوع منبع دارای یک یا چند نمایش داده و یک یا چند روش است.

انواع منابع

  1. انتخابات
  2. نمایندگان
  3. بخش ها

انتخابات

برای جزئیات منابع انتخاباتی، صفحه نمایندگی منابع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/civicinfo/v2، مگر اینکه خلاف آن ذکر شده باشد
پرس و جو انتخابات GET /elections فهرست انتخابات موجود برای پرس و جو
voterInfoQuery GET /voterinfo اطلاعات مربوط به رای دهنده را بر اساس آدرس ثبت شده رای دهنده جستجو می کند.

پارامترهای پرس و جو مورد نیاز: address

نمایندگان

برای جزئیات منابع نمایندگان، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/civicinfo/v2، مگر اینکه خلاف آن ذکر شده باشد
نمایندهInfoByAddress GET /representatives جغرافیای سیاسی و اطلاعات نماینده را برای یک آدرس جستجو می کند.
نمایندهInfoByDivision GET /representatives/ ocdId اطلاعات نماینده یک بخش جغرافیایی را جستجو می کند.

بخش ها

برای جزئیات منابع بخش، صفحه نمایش منبع را ببینید.

روش درخواست HTTP شرح
URI های مربوط به https://www.googleapis.com/civicinfo/v2، مگر اینکه خلاف آن ذکر شده باشد
جستجو کردن GET /divisions تقسیم بندی های سیاسی را با نام طبیعی یا شناسه OCD جستجو می کند.