@spec all(Keyword.t()) :: {:ok, [ExIbge.Geography.Microregion.t()]} | {:error, any()}

Get all microregions.

Parameters

• query - Optional parameters supported by the API (e.g., order_by: :name).

Examples

iex> ExIbge.Locality.Microregion.all()
{:ok, [%ExIbge.Geography.Microregion{id: 11001, name: "Ji-Paraná", ...}, ...]}

See Also

IBGE API: Microrregiões

@spec all!(Keyword.t()) :: [ExIbge.Geography.Microregion.t()]

Same as all/1, but raises an error on failure.

@spec find(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  {:ok, [ExIbge.Geography.Microregion.t()]} | {:error, any()}

Get microregion(s) by identifier(s).

Parameters

• ids - A single integer ID or a list of integer IDs.
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.Microregion.find(33007)
{:ok, [%ExIbge.Geography.Microregion{id: 33007, name: "Nova Friburgo", ...}]}

See Also

IBGE API: Microrregião por ID

@spec find!(integer() | String.t() | [integer() | String.t()], Keyword.t()) :: [
  ExIbge.Geography.Microregion.t()
]

Same as find/2, but raises an error on failure.

@spec get_by_mesoregion(
  integer() | String.t() | [integer() | String.t()],
  Keyword.t()
) ::
  {:ok, [ExIbge.Geography.Microregion.t()]} | {:error, any()}

Get microregions by mesoregion identifier(s).

Parameters

• mesoregion_ids - A single integer ID or a list of integer IDs.
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.Microregion.get_by_mesoregion(3303)
{:ok, [%ExIbge.Geography.Microregion{...}, ...]}

See Also

IBGE API: Microrregiões por Mesorregião

@spec get_by_mesoregion!(
  integer() | String.t() | [integer() | String.t()],
  Keyword.t()
) :: [
  ExIbge.Geography.Microregion.t()
]

Same as get_by_mesoregion/2, but raises an error on failure.

@spec get_by_region(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  {:ok, [ExIbge.Geography.Microregion.t()]} | {:error, any()}

Get microregions by region identifier(s).

Parameters

• region_ids - A single integer ID or a list of integer IDs (1-5).
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.Microregion.get_by_region(3)
{:ok, [%ExIbge.Geography.Microregion{...}, ...]}

See Also

IBGE API: Microrregiões por Região

@spec get_by_region!(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  [
    ExIbge.Geography.Microregion.t()
  ]

Same as get_by_region/2, but raises an error on failure.

@spec get_by_state(
  integer() | atom() | String.t() | [integer() | atom() | String.t()],
  Keyword.t()
) :: {:ok, [ExIbge.Geography.Microregion.t()]} | {:error, any()}

Get microregions by state identifier(s).

Parameters

• uf_ids - A single identifier or list of identifiers (Integer ID or Atom UFs).
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.Microregion.get_by_state(33)
{:ok, [%ExIbge.Geography.Microregion{...}, ...]}

iex> ExIbge.Locality.Microregion.get_by_state(:rj)
{:ok, [%ExIbge.Geography.Microregion{...}, ...]}

See Also

IBGE API: Microrregiões por UF

@spec get_by_state!(
  integer() | atom() | String.t() | [integer() | atom() | String.t()],
  Keyword.t()
) :: [ExIbge.Geography.Microregion.t()]

Same as get_by_state/2, but raises an error on failure.