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 ראשי תיבות של שם המדינה בן 2 האותיות בארה"ב, של הכתובת.
normalizedInput.zip string המיקוד בכתובת בארה"ב.
divisions object מחלקות גיאוגרפיות פוליטיות שמכילות את הכתובת המבוקשת. למידע נוסף, עיינו במסמכי התיעוד בנושא המשאב 'נציגים'.
offices[] list המשרדים שנבחרו שמוזכרים על ידי המחלקות המפורטות למעלה. יופיע רק אם הבקשה IncludeOffices הייתה true. למידע נוסף, עיינו במסמכי התיעוד בנושא המשאב 'נציגים'.
officials[] list נציגים רשמיים של המשרדים הרשומים למעלה. יופיע רק אם הבקשה IncludeOffices הייתה true. למידע נוסף, עיינו במסמכי התיעוד בנושא המשאב 'נציגים'.

רוצה לנסות?