Representatives: representativeInfoByAddress

Wyszukuje informacje geograficzne i reprezentatywne dane polityczne dla pojedynczego adresu. Wypróbuj teraz

Prośba

Żądanie HTTP

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

Parametry

Nazwa parametru Wartość Opis
Opcjonalne parametry zapytania
address string Adres do wyszukania. Można go określić tylko wtedy, gdy w adresie URL nie podano pola ocdId.
includeOffices boolean Czy zwracać informacje o urzędach i urzędnikach. Jeśli ma wartość false (fałsz), zwracane są tylko informacje o okręgu najwyższego poziomu. (Domyślnie: true)
levels string Lista poziomów biur, według których można filtrować dane. Zwracane są tylko te urzędy, które obsługują co najmniej jeden z tych poziomów. Działy, które nie zawierają pasującego biura, nie zostaną zwrócone.

Akceptowane wartości:
  • "administrativeArea1"
  • "administrativeArea2"
  • "country"
  • "international"
  • "locality"
  • "regional"
  • "special"
  • "subLocality1"
  • "subLocality2"
roles string Lista ról biurowych, według których można filtrować. Zwrócone zostaną tylko biura, które spełniają jedną z tych ról. Działy, które nie zawierają pasującego biura, nie zostaną zwrócone.

Akceptowane wartości:
  • "deputyHeadOfGovernment"
  • "executiveCouncil"
  • "governmentOfficer"
  • "headOfGovernment"
  • "headOfState"
  • "highestCourtJudge"
  • "judge"
  • "legislatorLowerBody"
  • "legislatorUpperBody"
  • "schoolBoard"
  • "specialPurposeOfficer"

Treść żądania

Nie podawaj treści żądania za pomocą tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

{
  "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
        }
      ]
    }
  ]
}
nazwa usługi, Wartość Opis Uwagi
kind string Określa rodzaj danego zasobu. Wartość: ustalony ciąg znaków "civicinfo#representativeInfoResponse".
normalizedInput nested object Znormalizowana wersja żądanego adresu
normalizedInput.locationName string Nazwa lokalizacji.
normalizedInput.line1 string Nazwa ulicy i numer tego adresu.
normalizedInput.line2 string Drugi wiersz adresu (w razie potrzeby).
normalizedInput.line3 string Trzeci wiersz adresu, jeśli jest potrzebny.
normalizedInput.city string Miasto lub miejscowość dla adresu.
normalizedInput.state string Dwuliterowy skrót adresu w Stanach Zjednoczonych.
normalizedInput.zip string Kod pocztowy adresu w Stanach Zjednoczonych.
divisions object Polityczne jednostki geograficzne, które zawierają żądany adres. Więcej informacji znajdziesz w dokumentacji zasobu reprezentatywnego.
offices[] list Wybrane urzędy, do których odwołują się wymienione powyżej działy. Jest widoczny tylko wtedy, gdy w żądaniu element includeOffices ma wartość true (prawda). Więcej informacji znajdziesz w dokumentacji zasobu reprezentatywnego.
officials[] list Urzędnicy zarządzający biurami wymienionymi powyżej. Będzie widoczny tylko wtedy, gdy w żądaniu parametr includeOffices ma wartość true (prawda). Więcej informacji znajdziesz w dokumentacji zasobu reprezentatywnego.

Wypróbuj