blob: 32229335a7597d0fe3ec57315ef4144d0ab8b72c [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.divisions.html">divisions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#search">search(query=None, x__xgafv=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070082<p class="firstline">Searches for political divisions by their natural name or OCD ID.</p>
83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 <code class="details" id="search">search(query=None, x__xgafv=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070091 <pre>Searches for political divisions by their natural name or OCD ID.
92
93Args:
94 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
Bu Sun Kimd059ad82020-07-22 17:02:09 -070095 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -070099
100Returns:
101 An object of the form:
102
103 { # The result of a division search query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 &quot;kind&quot;: &quot;civicinfo#divisionSearchResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;civicinfo#divisionSearchResponse&quot;.
105 &quot;results&quot;: [
106 { # Represents a political geographic division that matches the requested query.
107 &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.
108 &quot;A String&quot;,
109 ],
110 &quot;name&quot;: &quot;A String&quot;, # The name of the division.
111 &quot;ocdId&quot;: &quot;A String&quot;, # The unique Open Civic Data identifier for this division
112 },
113 ],
114}</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700115</div>
116
117</body></html>