Representatives: representativeInfoByAddress

ค้นหาภูมิศาสตร์ทางการเมืองและข้อมูลตัวแทนสำหรับที่อยู่เดียว ลองเลย

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์การค้นหาที่ไม่บังคับ
address string ที่อยู่ที่จะค้นหา สามารถระบุได้เฉพาะกรณีที่ไม่ได้ระบุช่อง ocdId ใน URL
includeOffices boolean ส่งคืนข้อมูลเกี่ยวกับสำนักงานและเจ้าหน้าที่หรือไม่ หากเป็น "เท็จ" ระบบจะแสดงเฉพาะข้อมูลของเขตการศึกษาระดับบนสุด (ค่าเริ่มต้น: true)
levels string รายการระดับของสำนักงานสำหรับกรอง จะมีการส่งคืนเฉพาะสำนักงานที่ให้บริการอย่างน้อย 1 ระดับเท่านั้น แผนกที่ไม่มีสำนักงานที่ตรงกันจะไม่ถูกส่งกลับ

ค่าที่ยอมรับมีดังนี้
  • "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
        }
      ]
    }
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
kind string ระบุประเภทของทรัพยากร ค่า: สตริงคงที่ "civicinfo#representativeInfoResponse"
normalizedInput nested object ที่อยู่ที่ขอในเวอร์ชันปกติ
normalizedInput.locationName string ชื่อของสถานที่ตั้ง
normalizedInput.line1 string ชื่อถนนและเลขที่ของที่อยู่นี้
normalizedInput.line2 string บรรทัดที่ 2 คือที่อยู่ หากจำเป็น
normalizedInput.line3 string บรรทัดที่ 3 ของที่อยู่ หากจำเป็น
normalizedInput.city string เมืองสำหรับที่อยู่
normalizedInput.state string อักษรย่อรัฐ 2 ตัวของสหรัฐอเมริกาของที่อยู่
normalizedInput.zip string รหัสไปรษณีย์ของสหรัฐอเมริกาของที่อยู่
divisions object เขตทางภูมิศาสตร์ทางการเมืองที่มีที่อยู่ที่ขอ ดูรายละเอียดเพิ่มเติมได้ในเอกสารแหล่งข้อมูลเกี่ยวกับการเป็นตัวแทน
offices[] list ตำแหน่งที่ได้รับเลือกตั้งที่อ้างอิงโดยหน่วยงานที่ระบุไว้ข้างต้น จะปรากฏก็ต่อเมื่อ includeOffices เป็นจริงในคำขอเท่านั้น ดูรายละเอียดเพิ่มเติมได้ในเอกสารแหล่งข้อมูลเกี่ยวกับการเป็นตัวแทน
officials[] list เจ้าหน้าที่ผู้ดำรงตำแหน่งราชการที่ระบุไว้ข้างต้น จะปรากฏก็ต่อเมื่อ includeOffices เป็นจริงในคำขอเท่านั้น ดูรายละเอียดเพิ่มเติมได้ในเอกสารแหล่งข้อมูลเกี่ยวกับการเป็นตัวแทน

ลองใช้เลย