Representatives: representativeInfoByAddress

Mencari geografi politik dan informasi representatif untuk satu alamat. Coba sekarang.

Permintaan

Permintaan HTTP

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

Parameter

Nama parameter Nilai Deskripsi
Parameter kueri opsional
address string Alamat yang akan dicari. Hanya dapat ditentukan jika kolom ocdId tidak yang diberikan dalam URL.
includeOffices boolean Apakah akan mengembalikan informasi tentang kantor dan pejabat. Jika salah, hanya informasi distrik tingkat teratas akan ditampilkan. (Default: true)
levels string Daftar tingkat kantor untuk difilter. Hanya kantor yang melayani setidaknya salah satu level ini akan ditampilkan. Divisi yang tidak berisi kantor yang cocok tidak akan dikembalikan.

Nilai yang dapat diterima:
  • "administrativeArea1"
  • "administrativeArea2"
  • "country"
  • "international"
  • "locality"
  • "regional"
  • "special"
  • "subLocality1"
  • "subLocality2"
roles string Daftar peran kantor yang dapat difilter. Hanya kantor yang memenuhi salah satu peran-peran ini akan ditampilkan. Pembagian yang tidak berisi pencocokan kantor tidak akan dikembalikan.

Nilai yang dapat diterima:
  • "deputyHeadOfGovernment"
  • "executiveCouncil"
  • "governmentOfficer"
  • "headOfGovernment"
  • "headOfState"
  • "highestCourtJudge"
  • "judge"
  • "legislatorLowerBody"
  • "legislatorUpperBody"
  • "schoolBoard"
  • "specialPurposeOfficer"

Isi permintaan

Jangan berikan isi permintaan dengan metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "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
        }
      ]
    }
  ]
}
Nama properti Nilai Deskripsi Catatan
kind string Mengidentifikasi jenis resource ini. Nilai: string tetap "civicinfo#representativeInfoResponse".
normalizedInput nested object Versi normalisasi dari alamat yang diminta
normalizedInput.locationName string Nama lokasi.
normalizedInput.line1 string Nama dan nomor jalan untuk alamat ini.
normalizedInput.line2 string Baris kedua alamat, jika diperlukan.
normalizedInput.line3 string Baris ketiga alamat, jika diperlukan.
normalizedInput.city string Kota untuk alamat.
normalizedInput.state string Singkatan negara bagian AS yang terdiri dari dua huruf.
normalizedInput.zip string Kode Pos Amerika Serikat untuk alamat tersebut.
divisions object Pemisahan geografis politik yang berisi permintaan alamat IPv6 Untuk detail selengkapnya, lihat Perwakilan dokumentasi resource.
offices[] list Kantor terpilih yang dirujuk oleh divisi yang tercantum di atas. Akan hanya ada jika includeOffices benar dalam permintaan. Untuk detail selengkapnya, lihat Perwakilan dokumentasi resource.
officials[] list Pejabat yang memegang jabatan yang tercantum di atas. Hanya akan ada jika includeOffices benar dalam permintaan. Untuk detail selengkapnya, lihat Perwakilan dokumentasi resource.

Cobalah!