View Source GoogleApi.CivicInfo.V2.Api.Divisions (google_api_civic_info v0.24.0)
API calls for all endpoints tagged Divisions
.
Summary
Functions
Lookup OCDIDs and names for divisions related to an address.
Searches for political divisions by their natural name or OCD ID.
Functions
Link to this function
civicinfo_divisions_query_division_by_address(connection, optional_params \\ [], opts \\ [])
View Source@spec civicinfo_divisions_query_division_by_address( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CivicInfo.V2.Model.DivisionByAddressResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lookup OCDIDs and names for divisions related to an address.
Parameters
-
connection
(type:GoogleApi.CivicInfo.V2.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:address
(type:String.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CivicInfo.V2.Model.DivisionByAddressResponse{}}
on success -
{:error, info}
on failure
Link to this function
civicinfo_divisions_search(connection, optional_params \\ [], opts \\ [])
View Source@spec civicinfo_divisions_search(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CivicInfo.V2.Model.DivisionSearchResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for political divisions by their natural name or OCD ID.
Parameters
-
connection
(type:GoogleApi.CivicInfo.V2.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:query
(type:String.t
) - 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
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CivicInfo.V2.Model.DivisionSearchResponse{}}
on success -
{:error, info}
on failure