Blame - docs/dyn/civicinfo_v2.representatives.html - platform/external/python/google-api-python-client

2014-10-15 10:26:14 -0700

[diff] [blame]

82

<p class="firstline">Looks up political geography and representative information for a single address.</p>

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, levels=None, recursive=None, x__xgafv=None)</a></code></p>

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

85

<p class="firstline">Looks up representative information for a single geographic division.</p>

86

<h3>Method Details</h3>

87

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

93

<code class="details" id="representativeInfoByAddress">representativeInfoByAddress(roles=None, address=None, levels=None, includeOffices=None, x__xgafv=None)</code>

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

94

<pre>Looks up political geography and representative information for a single address.

95

96

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)

Allowed values

headOfState -

headOfGovernment -

deputyHeadOfGovernment -

102

governmentOfficer -

103

executiveCouncil -

104

legislatorUpperBody -

105

legislatorLowerBody -

highestCourtJudge -

judge -

schoolBoard -

specialPurposeOfficer -

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

110

address: string, The address to look up. May only be specified if the field ocdId is not given in the URL

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

111

levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

Allowed values

international -

country -

administrativeArea1 -

116

regional -

117

administrativeArea2 -

locality -

subLocality1 -

subLocality2 -

special -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

122

includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

x__xgafv: string, V1 error format.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

124

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

125

1 - v1 error format

126

2 - v2 error format

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

127

128

Returns:

129

An object of the form:

130

131

{ # The result of a representative info lookup query.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

132

"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

133

"state": "A String", # The US two letter state abbreviation of the address.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

134

"line3": "A String", # The third line of the address, if needed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

135

"city": "A String", # The city or town for the address.

136

"locationName": "A String", # The name of the location.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

137

"line2": "A String", # The second line the address, if needed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

138

"zip": "A String", # The US Postal Zip Code of the address.

139

"line1": "A String", # The street name and number of this address.

140

},

141

"officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.

142

{ # Information about a person holding an elected office.

143

"urls": [ # The official's public website URLs.

144

"A String",

145

],

146

"emails": [ # The direct email addresses for the official.

147

"A String",

148

],

149

"channels": [ # A list of known (social) media channels for this official.

150

{ # A social media or web channel for a candidate.

151

"type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter

152

"id": "A String", # The unique public identifier for the candidate's channel.

153

},

154

],

155

"address": [ # Addresses at which to contact the official.

156

{ # A simple representation of an address.

157

"state": "A String", # The US two letter state abbreviation of the address.

158

"line3": "A String", # The third line of the address, if needed.

159

"city": "A String", # The city or town for the address.

160

"locationName": "A String", # The name of the location.

161

"line2": "A String", # The second line the address, if needed.

162

"zip": "A String", # The US Postal Zip Code of the address.

163

"line1": "A String", # The street name and number of this address.

164

},

165

],

166

"phones": [ # The official's public contact phone numbers.

167

"A String",

168

],

169

"party": "A String", # The full name of the party the official belongs to.

170

"name": "A String", # The official's name.

171

"photoUrl": "A String", # A URL for a photo of the official.

172

},

173

],

174

"divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.

175

"a_key": { # Describes a political geography.

176

"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.

177

"A String",

178

],

179

"name": "A String", # The name of the division.

180

"officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.

181

42,

182

],

183

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

184

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

185

"kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".

186

"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.

187

{ # Information about an Office held by one or more Officials.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

188

"officialIndices": [ # List of indices in the officials array of people who presently hold this office.

189

42,

190

],

191

"divisionId": "A String", # The OCD ID of the division with which this office is associated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

192

"roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

193

"A String",

194

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

195

"sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.

196

{ # Contains information about the data source for the element containing it.

197

"name": "A String", # The name of the data source.

198

"official": True or False, # Whether this data comes from an official government source.

199

},

200

],

201

"levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".

202

"A String",

203

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

204

"name": "A String", # The human-readable name of the office.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

205

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

206

],

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

211

<code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, levels=None, recursive=None, x__xgafv=None)</code>

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

212

<pre>Looks up representative information for a single geographic division.

213

214

Args:

215

ocdId: string, The Open Civic Data division identifier of the division to look up. (required)

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

216

roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

Allowed values

headOfState -

headOfGovernment -

deputyHeadOfGovernment -

221

governmentOfficer -

222

executiveCouncil -

223

legislatorUpperBody -

224

legislatorLowerBody -

highestCourtJudge -

judge -

schoolBoard -

specialPurposeOfficer -

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

229

levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned. (repeated)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

Allowed values

international -

country -

administrativeArea1 -

234

regional -

235

administrativeArea2 -

locality -

subLocality1 -

subLocality2 -

special -

recursive: boolean, If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

241

x__xgafv: string, V1 error format.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

242

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

243

1 - v1 error format

244

2 - v2 error format

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

245

246

Returns:

247

An object of the form:

248

249

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

250

"divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.

251

"a_key": { # Describes a political geography.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

252

"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.

253

"A String",

254

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

255

"name": "A String", # The name of the division.

256

"officeIndices": [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.

257

42,

258

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

259

},

260

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

261

"officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.

262

{ # Information about a person holding an elected office.

263

"urls": [ # The official's public website URLs.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

264

"A String",

265

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

266

"emails": [ # The direct email addresses for the official.

267

"A String",

268

],

269

"channels": [ # A list of known (social) media channels for this official.

270

{ # A social media or web channel for a candidate.

271

"type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter

272

"id": "A String", # The unique public identifier for the candidate's channel.

273

},

274

],

275

"address": [ # Addresses at which to contact the official.

276

{ # A simple representation of an address.

277

"state": "A String", # The US two letter state abbreviation of the address.

278

"line3": "A String", # The third line of the address, if needed.

279

"city": "A String", # The city or town for the address.

280

"locationName": "A String", # The name of the location.

281

"line2": "A String", # The second line the address, if needed.

282

"zip": "A String", # The US Postal Zip Code of the address.

283

"line1": "A String", # The street name and number of this address.

284

},

285

],

286

"phones": [ # The official's public contact phone numbers.

287

"A String",

288

],

289

"party": "A String", # The full name of the party the official belongs to.

290

"name": "A String", # The official's name.

291

"photoUrl": "A String", # A URL for a photo of the official.

292

},

293

],

294

"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.

295

{ # Information about an Office held by one or more Officials.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

296

"officialIndices": [ # List of indices in the officials array of people who presently hold this office.

297

42,

298

],

299

"divisionId": "A String", # The OCD ID of the division with which this office is associated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

300

"roles": [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.

301

"A String",

302

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

303

"sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.

304

{ # Contains information about the data source for the element containing it.

305

"name": "A String", # The name of the data source.

306

"official": True or False, # Whether this data comes from an official government source.

307

},

308

],

309

"levels": [ # The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".

310

"A String",

311

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

312

"name": "A String", # The human-readable name of the office.

Craig Citro