Representatives: representativeInfoByAddress

חיפוש מיקום גיאוגרפי פוליטי ומידע מייצג בכתובת אחת. רוצים לנסות עכשיו?

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר ערך תיאור
פרמטרים אופציונליים של שאילתה
address string הכתובת לחיפוש. ניתן לציין רק אם השדה ocdId אינו שניתנו בכתובת ה-URL.
includeOffices boolean האם להחזיר מידע על משרדים ונציגים רשמיים. אם False, רק יוחזר המידע ברמה העליונה של המחוז. (ברירת המחדל: 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 חלוקות גיאוגרפיות פוליטיות שמכילות את address. פרטים נוספים זמינים במאמר הנציגים מקורות מידע.
offices[] list משרדים נבחרים שמוזכרים על ידי המחלקות המפורטות למעלה. וויל קיים רק אם הפרמטר IncludeOffices היה True בבקשה. פרטים נוספים זמינים במאמר הנציגים מקורות מידע.
officials[] list נציגים רשמיים האחראים על המשרדים שצוינו למעלה. יופיע רק אם הפרמטר IncludeOffices היה True בבקשה. פרטים נוספים זמינים במאמר הנציגים מקורות מידע.

נסה בעצמך!