Representatives: representativeInfoByAddress

جغرافیای سیاسی و اطلاعات نماینده را برای یک آدرس جستجو می کند. اکنون آن را امتحان کنید .

درخواست کنید

درخواست HTTP 

GET https://www.googleapis.com/civicinfo/v2/representatives

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای پرس و جو اختیاری
address string آدرسی که باید جستجو کنید فقط در صورتی ممکن است که فیلد ocdId در URL داده نشده باشد مشخص شود.
includeOffices boolean آیا باید اطلاعات مربوط به دفاتر و مقامات را برگرداند. اگر نادرست باشد، فقط اطلاعات سطح بالای منطقه برگردانده می شود. (پیش‌فرض: true )
levels string فهرستی از سطوح اداری برای فیلتر کردن. فقط دفاتری که حداقل یکی از این سطوح را ارائه می دهند بازگردانده می شوند. بخش هایی که دارای دفتر منطبق نباشند بازگردانده نمی شوند.

مقادیر قابل قبول عبارتند از:
  • " administrativeArea1 "
  • " administrativeArea2 "
  • " country "
  • " international "
  • " locality "
  • " regional "
  • " special "
  • " subLocality1 "
  • " subLocality2 "
roles string فهرستی از نقش‌های اداری برای فیلتر کردن. فقط دفاتری که یکی از این نقش ها را انجام می دهند بازگردانده می شوند. بخش هایی که دارای دفتر منطبق نباشند بازگردانده نمی شوند.

مقادیر قابل قبول عبارتند از:
  • " deputyHeadOfGovernment "
  • " executiveCouncil "
  • " governmentOfficer "
  • " headOfGovernment "
  • " headOfState "
  • " highestCourtJudge "
  • " judge "
  • " legislatorLowerBody "
  • " legislatorUpperBody "
  • " schoolBoard "
  • " specialPurposeOfficer "

درخواست بدن

با این روش بدنه درخواستی ارائه نکنید.

پاسخ

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند: 

{
  "kind": "civicinfo#representativeInfoResponse",
  "normalizedInput": {
    "locationName": string,
    "line1": string,
    "line2": string,
    "line3": string,
    "city": string,
    "state": string,
    "zip": string
  },
  "divisions": {
    (key): {
      "name": string,
      "alsoKnownAs": [
        string
      ],
      "officeIndices": [
        unsigned integer
      ]
    }
  },
  "offices": [
    {
      "name": string,
      "divisionId": string,
      "levels": [
        string
      ],
      "roles": [
        string
      ],
      "sources": [
        {
          "name": string,
          "official": boolean
        }
      ],
      "officialIndices": [
        unsigned integer
      ]
    }
  ],
  "officials": [
    {
      "name": string,
      "address": [
        {
          "locationName": string,
          "line1": string,
          "line2": string,
          "line3": string,
          "city": string,
          "state": string,
          "zip": string
        }
      ],
      "party": string,
      "phones": [
        string
      ],
      "urls": [
        string
      ],
      "photoUrl": string,
      "emails": [
        string
      ],
      "channels": [
        {
          "type": string,
          "id": string
        }
      ]
    }
  ]
}
نام ملک ارزش توضیحات یادداشت ها
kind string مشخص می کند که این چه نوع منبعی است. مقدار: رشته ثابت "civicinfo#representativeInfoResponse" .
normalizedInput nested object نسخه عادی آدرس درخواستی
normalizedInput. locationName string نام مکان.
normalizedInput. line1 string نام خیابان و شماره این آدرس.
normalizedInput. line2 string خط دوم آدرس، در صورت نیاز.
normalizedInput. line3 string خط سوم آدرس در صورت نیاز.
normalizedInput. city string شهر یا شهر برای آدرس.
normalizedInput. state string ایالات متحده دو حرف مخفف آدرس.
normalizedInput. zip string کد پستی ایالات متحده آدرس.
divisions object تقسیمات جغرافیایی سیاسی که حاوی آدرس درخواستی است. برای جزئیات بیشتر، به مستندات منابع نمایندگان مراجعه کنید.
offices[] list دفاتر منتخب ارجاع شده توسط بخش های ذکر شده در بالا. فقط در صورتی حضور خواهد داشت که includeOffices در درخواست درست باشد. برای جزئیات بیشتر، به مستندات منابع نمایندگان مراجعه کنید.
officials[] list مقامات دارای دفاتر ذکر شده در بالا. فقط در صورتی حضور خواهد داشت که includeOffices در درخواست درست باشد. برای جزئیات بیشتر، به مستندات منابع نمایندگان مراجعه کنید.

آن را امتحان کنید!