SudregEx.Api (sudreg_ex v0.1.0)

Copy Markdown View Source

One function per v3 "javni" (public) Sudski registar endpoint, over SudregEx.Request.request/3.

Every function has the shape name(client, opts \\ []) and returns {:ok, %SudregEx.Response{}} | {:error, %SudregEx.Error{}}. opts mixes the endpoint's query params (e.g. only_active:, limit:, expand_relations:) with the pipeline opts :token, :token_cache, :format (see SudregEx.Request). Booleans are encoded as "1"/"0" and nil params are dropped by the request layer.

Query params are whitelisted per endpoint against the OpenAPI: passing a param an endpoint does not support raises ArgumentError (catching typos).

{:ok, resp} = SudregEx.Api.subjekti(client, only_active: true, limit: 100)
{:ok, resp} = SudregEx.Api.detalji_subjekta(client, tip_identifikatora: "oib", identifikator: "12345678901")

The endpoint table is transcribed from priv/doc/open_api_javni_v3.json; a test asserts it stays in sync with the spec. endpoints/0 returns it for introspection.

Summary

Functions

Šifrarnik BRIS pravnih oblika

Šifrarnik BRIS registara

Popis ukupnog broja dostupnih aktivnih i povijesnih redaka za sve metode/tablice

Svi podaci o subjektu skupljeni u jedan strukturirani objekt

Evidencija djelatnosti podružnica

Šifrarnik država

Evidencija e-mail adresa subjekata

Evidencija e-mail adresa podružnica

Returns the endpoint metadata table (one map per endpoint).

Popis evidencijskih djelatnosti subjekata

Evidencija predanih godišnjih financijskih izvješća subjekata

Evidencija podataka o inozemnim registrima subjekata (za inozemne podružnice)

Šifrarnik jezika

Returns the id of the most recent snapshot (staleness == 1), so it can be threaded as snapshot_id: through a sequence of calls for a consistent read.

Nacionalna klasifikacija djelatnosti

Evidencija naziva podružnica subjekata

Evidencija načina objave priopćenja subjekata

Evidencija partnera u statusnim postupcima subjekata

Evidencija postupaka nad subjektima

Evidencija pravnih oblika subjekata

Evidencija predmeta poslovanja (djelatnosti) subjekata

Evidencija pretežitih djelatnosti subjekata

Evidencija prijevoda skraćenih tvrtki subjekata

Evidencija prijevoda tvrtki subjekata

Popis zadnjih promjena nad subjektima

Evidencija sjedišta i adresa subjekata

Evidencija sjedišta i adresa podružnica subjekata

Evidencija skraćenih tvrtki subjekata

Evidencija naziva podružnica subjekata

Popis snimki glavne baze sudskog registra

Šifrarnik statusa retka

Evidencija statusnih postupaka (pravnih odnosa) subjekata

Lazily streams every row of a paginated endpoint, walking offset/limit.

Evidencija osnovnih podataka o subjektima

Šifrarnik sudova

Evidencija temeljnih kapitala subjekata

Evidencija tvrtki (naziva) subjekata

Šifrarnik valuta

Šifrarnik vrsta GFI dokumenata

Šifrarnik vrsta postupaka

Šifrarnik vrsta pravnih oblika

Šifrarnik vrsta statusnih postupaka

Functions

bris_pravni_oblici(client, opts \\ [])

@spec bris_pravni_oblici(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik BRIS pravnih oblika

bris_registri(client, opts \\ [])

@spec bris_registri(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik BRIS registara

counts(client, opts \\ [])

@spec counts(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Popis ukupnog broja dostupnih aktivnih i povijesnih redaka za sve metode/tablice

detalji_subjekta(client, opts \\ [])

@spec detalji_subjekta(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Svi podaci o subjektu skupljeni u jedan strukturirani objekt

djelatnosti_podruznica(client, opts \\ [])

@spec djelatnosti_podruznica(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija djelatnosti podružnica

drzave(client, opts \\ [])

@spec drzave(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik država

email_adrese(client, opts \\ [])

@spec email_adrese(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija e-mail adresa subjekata

email_adrese_podruznica(client, opts \\ [])

@spec email_adrese_podruznica(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija e-mail adresa podružnica

endpoints()

@spec endpoints() :: [map()]

Returns the endpoint metadata table (one map per endpoint).

evidencijske_djelatnosti(client, opts \\ [])

@spec evidencijske_djelatnosti(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Popis evidencijskih djelatnosti subjekata

gfi(client, opts \\ [])

@spec gfi(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija predanih godišnjih financijskih izvješća subjekata

inozemni_registri(client, opts \\ [])

@spec inozemni_registri(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija podataka o inozemnim registrima subjekata (za inozemne podružnice)

jezici(client, opts \\ [])

@spec jezici(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik jezika

latest_snapshot_id(client, opts \\ [])

@spec latest_snapshot_id(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, integer()} | {:error, SudregEx.Error.t()}

Returns the id of the most recent snapshot (staleness == 1), so it can be threaded as snapshot_id: through a sequence of calls for a consistent read.

nacionalna_klasifikacija_djelatnosti(client, opts \\ [])

@spec nacionalna_klasifikacija_djelatnosti(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Nacionalna klasifikacija djelatnosti

nazivi_podruznica(client, opts \\ [])

@spec nazivi_podruznica(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija naziva podružnica subjekata

objave_priopcenja(client, opts \\ [])

@spec objave_priopcenja(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija načina objave priopćenja subjekata

partneri_statusnih_postupaka(client, opts \\ [])

@spec partneri_statusnih_postupaka(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija partnera u statusnim postupcima subjekata

postupci(client, opts \\ [])

@spec postupci(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija postupaka nad subjektima

pravni_oblici(client, opts \\ [])

@spec pravni_oblici(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija pravnih oblika subjekata

predmeti_poslovanja(client, opts \\ [])

@spec predmeti_poslovanja(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija predmeta poslovanja (djelatnosti) subjekata

pretezite_djelatnosti(client, opts \\ [])

@spec pretezite_djelatnosti(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija pretežitih djelatnosti subjekata

prijevodi_skracenih_tvrtki(client, opts \\ [])

@spec prijevodi_skracenih_tvrtki(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija prijevoda skraćenih tvrtki subjekata

prijevodi_tvrtki(client, opts \\ [])

@spec prijevodi_tvrtki(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija prijevoda tvrtki subjekata

promjene(client, opts \\ [])

@spec promjene(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Popis zadnjih promjena nad subjektima

sjedista(client, opts \\ [])

@spec sjedista(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija sjedišta i adresa subjekata

sjedista_podruznica(client, opts \\ [])

@spec sjedista_podruznica(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija sjedišta i adresa podružnica subjekata

skracene_tvrtke(client, opts \\ [])

@spec skracene_tvrtke(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija skraćenih tvrtki subjekata

skraceni_nazivi_podruznica(client, opts \\ [])

@spec skraceni_nazivi_podruznica(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija naziva podružnica subjekata

snapshots(client, opts \\ [])

@spec snapshots(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Popis snimki glavne baze sudskog registra

statusi(client, opts \\ [])

@spec statusi(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik statusa retka

statusni_postupci(client, opts \\ [])

@spec statusni_postupci(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija statusnih postupaka (pravnih odnosa) subjekata

stream(client, name, opts \\ [])

@spec stream(SudregEx.Client.t(), atom(), keyword()) :: Enumerable.t()

Lazily streams every row of a paginated endpoint, walking offset/limit.

name is an endpoint atom (e.g. :subjekti); opts are passed to the underlying wrapper (so :token, :snapshot_id, :only_active, … thread through every page). :limit sets the page size (default 1000); any :offset in opts is ignored — the stream manages it.

For a consistent read across many pages, pin a snapshot so the walk is not split across the daily refresh — pass snapshot_id: (e.g. from latest_snapshot_id/2). Do not request a :limit above the server's maximum page size: without X-Total-Count the stream would treat the capped short page as the end.

Raises ArgumentError if name is unknown or not paginated, and raises the SudregEx.Error if a page request fails (a lazy stream cannot carry an error tuple).

{:ok, snapshot_id} = SudregEx.Api.latest_snapshot_id(client)

SudregEx.Api.stream(client, :subjekti, snapshot_id: snapshot_id, only_active: true)
|> Enum.each(&handle/1)

subjekti(client, opts \\ [])

@spec subjekti(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija osnovnih podataka o subjektima

sudovi(client, opts \\ [])

@spec sudovi(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik sudova

temeljni_kapitali(client, opts \\ [])

@spec temeljni_kapitali(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija temeljnih kapitala subjekata

tvrtke(client, opts \\ [])

@spec tvrtke(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Evidencija tvrtki (naziva) subjekata

valute(client, opts \\ [])

@spec valute(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik valuta

vrste_gfi_dokumenata(client, opts \\ [])

@spec vrste_gfi_dokumenata(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik vrsta GFI dokumenata

vrste_postupaka(client, opts \\ [])

@spec vrste_postupaka(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik vrsta postupaka

vrste_pravnih_oblika(client, opts \\ [])

@spec vrste_pravnih_oblika(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik vrsta pravnih oblika

vrste_statusnih_postupaka(client, opts \\ [])

@spec vrste_statusnih_postupaka(
  SudregEx.Client.t(),
  keyword()
) :: {:ok, SudregEx.Response.t()} | {:error, SudregEx.Error.t()}

Šifrarnik vrsta statusnih postupaka