#api-client #version #csv #akvakulturregisteret #det #offentlige #nye

bin+lib akvakulturregisteret_rs

API for det nye offentlige Akvakulturregisteret

2 unstable releases

0.3.0 Jan 10, 2025
0.1.0 Jan 10, 2025

#441 in Web programming

28 downloads per month

MIT license

230KB
4.5K SLoC

Rust API client for akvakulturregisteret_rs

API for det nye offentlige Akvakulturregisteret

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

scoop install openapi-generator-cli
scoop bucket add java
scoop install openjdk
openapi-generator-cli generate -g rust -o C:\Users\emill\Desktop\dbt\akvakulturregisteret_rs\temp -i C:\Users\emill\Desktop\dbt\akvakulturregisteret_rs\spec.json --additional-properties=library=reqwest-trait,mockall=true,packageName=akvakulturregisteret_rs,supportMultipleResponses=true,topLevelApiClient=true,useBonBuilder=true

Documentation for CLI

Get JSON CSV dump

areg csv-dump

Download CSV file

areg csv-file-dump -o output.csv

Area commands

areg area <version-id>
areg area-by-code --type <type> --code <code> [--time <time>]
areg areas [--type <type>] [--code <code>] [--time <time>] [--range <range>]

License commands

areg license-transfers <license-nr>
areg license-by-nr <license-nr>
areg license-decisions <license-nr>
areg license-capacity-history <license-nr>
areg license-site-connections <license-nr>
areg licenses-overview [--license-nr <nr>] [--legal-entity-nr <nr>] [--legal-entity-name <name>] ...
areg license-liens <license-nr>

Documentation for API Endpoints

All URIs are relative to https://api.fiskeridir.no/pub-aqua

Class Method HTTP request Description
AreaResourceApi area GET /api/v1/areas/{version-id} Hent et spesifikt område
AreaResourceApi area_by_code_and_type GET /api/v1/areas/{type}/{code} Hent et spesifikt område etter type og kode
AreaResourceApi areas GET /api/v1/areas Henter en liste av områder
CsvDumpResourceApi get_new_legacy_csv_dump GET /api/v1/dump/new-legacy-csv Oppretter en CSV-dump av akvakulturregisteret
CsvDumpResourceApi get_new_legacy_csv_file_dump GET /api/v1/dump/new-legacy-csv-file Oppretter en CSV-fildump av akvakulturregisteret
EntityResourceApi entities GET /api/v1/entities Hent en liste av juridiske enheter
EntityResourceApi get_entity GET /api/v1/entities/{entity-nr-id} Hent angitt juridisk enhet
EntityResourceApi get_sites_for_entity GET /api/v1/entities/{entity-nr-id}/sites Hent en liste av lokaliteter hvor en juridisk enhet driver med akvakultur
EntityResourceApi get_sites_for_entity_by_legal_entity_nr GET /api/v1/entities/sites-by-entity-nr/{entity-nr} Henter en liste av lokaliteter benyttet av juridisk enhet identifisert ved fødselsnummer eller organisasjonsnummer
LicenseResourceApi get_ajour_transfers GET /api/v1/licenses/{license-nr}/transfers Hent ajour-dato på overføringer mellom juridiske enheter av tillatelse på tillatelsesnummer
LicenseResourceApi get_by_license_nr GET /api/v1/licenses/{license-nr} Hent en tillatelse etter tillatelsesnummer
LicenseResourceApi get_decisions1 GET /api/v1/licenses/{license-nr}/decisions Hent vedtak for tillatelse etter tillatelsesnummer
LicenseResourceApi get_license_capacity_history_by_license_nr GET /api/v1/licenses/{license-nr}/capacity-history Hent kapasistetshistorien for tillatelse etter tillatelsesnummer
LicenseResourceApi get_license_connection_for_site_by_site_nr1 GET /api/v1/licenses/{license-nr}/site-connections Hent lokalitetstilknytninger for tillatelse etter tillatelsesnummer
LicenseResourceApi get_licenses GET /api/v1/licenses Hent alle tillatelser som tilfredsstiller kriteriene for søkeparametere
LicenseResourceApi get_licenses_overview GET /api/v1/licenses-overview Hent alle tillatelser som tilfredsstiller kriteriene for søkeparametere
LicenseResourceApi get_liens GET /api/v1/licenses/{license-nr}/liens Hent panterettholdere av tillatelse etter tillatelsesnummer
LicenseTypeResourceApi get_license_intention GET /api/v1/license-types/intentions/{id} Hent formålet med en tillatelsestype basert på ID
LicenseTypeResourceApi get_license_intentions GET /api/v1/license-types/intentions Hent en liste av formål for hver tillatelsestype
SiteResourceApi get_borders_by_site_nr GET /api/v1/sites/{site-nr}/borders Hent grense rundt en lokalitet etter lokalitetsnummer
SiteResourceApi get_by_site_nr GET /api/v1/sites/{site-nr} Hent lokalitet etter lokalitetsnummer
SiteResourceApi get_decisions GET /api/v1/sites/{site-nr}/decisions Hent vedtak for lokalitet etter lokalitetsnummer
SiteResourceApi get_license_connection_for_site_by_site_nr GET /api/v1/sites/{site-nr}/license-connections Hent tillatelsesforbindelser for lokalitet etter lokalitetsnummer
SiteResourceApi sites GET /api/v1/sites Hent en liste av lokaliteter

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

akva-hjelp@fiskeridir.no

Dependencies

~9–21MB
~280K SLoC