google_api_civic_info v0.12.0 GoogleApi.CivicInfo.V2.Model.Office View Source

Information about an Office held by one or more Officials.

Attributes

  • divisionId (type: String.t, default: nil) - The OCD ID of the division with which this office is associated.
  • levels (type: list(String.t), default: nil) - 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".
  • name (type: String.t, default: nil) - The human-readable name of the office.
  • officialIndices (type: list(integer()), default: nil) - List of indices in the officials array of people who presently hold this office.
  • roles (type: list(String.t), default: nil) - 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.
  • sources (type: list(GoogleApi.CivicInfo.V2.Model.Source.t), default: nil) - A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.

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.Office{
  divisionId: String.t(),
  levels: [String.t()],
  name: String.t(),
  officialIndices: [integer()],
  roles: [String.t()],
  sources: [GoogleApi.CivicInfo.V2.Model.Source.t()]
}

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.