blob: b13213f1b40a9416bdb1c997c42b486602c532a5 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.divisions.html">divisions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#search">search(query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for political divisions by their natural name or OCD ID.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="search">search(query=None, x__xgafv=None)</code>
<pre>Searches for political divisions by their natural name or OCD ID.
Args:
query: string, The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The result of a division search query.
&quot;results&quot;: [
{ # Represents a political geographic division that matches the requested query.
&quot;name&quot;: &quot;A String&quot;, # The name of the division.
&quot;ocdId&quot;: &quot;A String&quot;, # The unique Open Civic Data identifier for this division
&quot;aliases&quot;: [ # Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.
&quot;A String&quot;,
],
},
],
&quot;kind&quot;: &quot;civicinfo#divisionSearchResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;civicinfo#divisionSearchResponse&quot;.
}</pre>
</div>
</body></html>