google_api_civic_info v0.1.0 GoogleApi.CivicInfo.V2.Model.GeographicDivision View Source

Describes a political geography.

Attributes

  • alsoKnownAs ([String.t]): Any other valid OCD IDs that refer to the same division. Because 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. For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc. Defaults to: null.
  • name (String.t): The name of the division. Defaults to: null.
  • officeIndices ([integer()]): 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. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type t() View Source
t() :: %GoogleApi.CivicInfo.V2.Model.GeographicDivision{
  alsoKnownAs: [any()],
  name: any(),
  officeIndices: [any()]
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.