Wyszukuje położenie geograficzne i informacje reprezentatywne dla pojedynczego adresu. Wypróbuj
Żądanie
Żą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 pole ocdId nie jest wartością podane w adresie URL. |
includeOffices |
boolean |
Określa, czy zwracać informacje o urzędach i urzędnikach. Jeśli ma wartość false (fałsz), tylko
zostaną zwrócone informacje dotyczące okręgu najwyższego poziomu.
(Domyślnie: true )
|
levels |
string |
Lista poziomów biur, według których można filtrować. Tylko biura obsługujące co najmniej
zostanie zwrócony jeden z tych poziomów. Oddziały, które nie zawierają znaku
pasujące biuro nie zostanie zwrócone.
Akceptowane wartości to:
|
roles |
string |
Lista ról biurowych, według których można filtrować. Tylko biura obsługujące jedno z
te role zostaną zwrócone. Działy, które nie zawierają dopasowania
nie zwróci biura.
Akceptowane wartości to:
|
Treść żądania
Nie podawaj treści żądania przy użyciu 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 |
W drugim wierszu (w razie potrzeby) wpisz adres. | |
normalizedInput.line3 |
string |
W razie potrzeby trzeci wiersz adresu. | |
normalizedInput.city |
string |
Miejscowość, w której znajduje się adres. | |
normalizedInput.state |
string |
Dwuliterowy skrót adresu stanu w Stanach Zjednoczonych. | |
normalizedInput.zip |
string |
Kod pocztowy w Stanach Zjednoczonych powiązany z adresem. | |
divisions |
object |
Polityczne jednostki geograficzne, które zawierają żądane adresu. Więcej informacji: Przedstawiciele zasobu. | |
offices[] |
list |
Wybrane urzędy, do których odnoszą się wymienione wyżej oddziały. Tomek być obecna tylko wtedy, gdy w żądaniu miała wartość „includeOffices” (prawda). Więcej informacji: Przedstawiciele zasobu. | |
officials[] |
list |
Urzędnicy obsługujący urzędy wymienione powyżej. Będzie tylko obecna jeśli parametr includeOffices ma wartość „prawda” w żądaniu. Więcej informacji: Przedstawiciele zasobu. |