Procura informações geográficas e representativas de um único endereço. Faça o teste agora.
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/civicinfo/v2/representatives
Parâmetros
Nome do parâmetro | Valor | Descrição |
---|---|---|
Parâmetros de consulta opcionais | ||
address |
string |
O endereço a ser pesquisado. Só poderá ser especificado se o campo ocdId não for fornecido no URL. |
includeOffices |
boolean |
Se informações sobre escritórios e funcionários devem ser retornadas. Se for falso, somente as informações do distrito superior serão retornadas.
Padrão: true .
|
levels |
string |
Uma lista de escritórios para filtrar. Somente escritórios que atendem a pelo menos um desses níveis serão retornados. Divisões que não contiverem um escritório correspondente não serão retornadas.
Os valores aceitáveis são:
|
roles |
string |
Uma lista de funções de escritório para filtrar. Somente os escritórios que cumprirem uma
dessas funções serão retornados. Divisões que não contiverem um escritório
correspondente não serão retornadas.
Os valores aceitáveis são:
|
Corpo da solicitação
Não forneça um corpo de solicitação com este método.
Resposta
Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:
{ "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 } ] } ] }
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
kind |
string |
Identifica o tipo de recurso. Valor: a string fixa "civicinfo#representativeInfoResponse" . |
|
normalizedInput |
nested object |
A versão normalizada do endereço solicitado | |
normalizedInput.locationName |
string |
Nome do local. | |
normalizedInput.line1 |
string |
O nome da rua e o número do endereço. | |
normalizedInput.line2 |
string |
A segunda linha é o endereço, se necessário. | |
normalizedInput.line3 |
string |
A terceira linha do endereço, se necessário. | |
normalizedInput.city |
string |
A cidade do endereço. | |
normalizedInput.state |
string |
A abreviação de duas letras do endereço nos EUA. | |
normalizedInput.zip |
string |
O CEP do endereço nos EUA. | |
divisions |
object |
Divisões geográficas políticas que contêm o endereço solicitado. Para mais detalhes, consulte a documentação do recurso Representativos. | |
offices[] |
list |
Cargos eleitos referenciados pelas divisões listadas acima. Só estará presente se includeOffices for verdadeiro na solicitação. Para mais detalhes, consulte a documentação do recurso Representativos. | |
officials[] |
list |
Funcionários que ocupam os escritórios listados acima Só estará presente se includeOffices for verdadeiro na solicitação. Para mais detalhes, consulte a documentação do recurso Representativos. |