@slovensko/register-adries

@SlovenskoRegisterAdries - JavaScript client for @slovensko/register-adries Register adries popis This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://himalia.sk

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @slovensko/register-adries --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @slovensko/register-adries from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @SlovenskoRegisterAdries = require('@slovensko/register-adries');

var defaultClient = @SlovenskoRegisterAdries.ApiClient.instance;
// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['api-key'] = "Token"
// Configure API key authorization: apiKeyQuery
var apiKeyQuery = defaultClient.authentications['apiKeyQuery'];
apiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyQuery.apiKeyPrefix['api-key'] = "Token"

var api = new @SlovenskoRegisterAdries.BudovaApi()
var id = "id_example"; // {String} Budova identifikátor
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.budovaControllerCastObce(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:3002

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @SlovenskoRegisterAdries.BudovaApi | budovaControllerCastObce | GET /Budova/{id}/castObce | Vráti castObce, do ktorého Budova patrí @SlovenskoRegisterAdries.BudovaApi | budovaControllerGet | GET /Budova | Vráti všetky budovy @SlovenskoRegisterAdries.BudovaApi | budovaControllerGetById | GET /Budova/{id} | Vráti Budova s príslušným identifikátorom @SlovenskoRegisterAdries.BudovaApi | budovaControllerObec | GET /Budova/{id}/obec | Vráti obec, do ktorého Budova patrí @SlovenskoRegisterAdries.BudovaApi | budovaControllerVchody | GET /Budova/{id}/vchody | Vráti všetky vchody ktoré sa nachádzajú v Budova @SlovenskoRegisterAdries.BytApi | bytControllerGet | GET /Byt | Vráti všetky byty @SlovenskoRegisterAdries.BytApi | bytControllerGetById | GET /Byt/{id} | Vráti Byt s príslušným identifikátorom @SlovenskoRegisterAdries.BytApi | bytControllerVchody | GET /Byt/{id}/vchody | Vráti vchody, do ktorého Byt patrí @SlovenskoRegisterAdries.CastObceApi | castObceControllerBudovy | GET /CastObce/{id}/budovy | Vráti všetky budovy ktoré sa nachádzajú v CastObce @SlovenskoRegisterAdries.CastObceApi | castObceControllerGet | GET /CastObce | Vráti všetky castiObce @SlovenskoRegisterAdries.CastObceApi | castObceControllerGetById | GET /CastObce/{id} | Vráti CastObce s príslušným identifikátorom @SlovenskoRegisterAdries.CastObceApi | castObceControllerObec | GET /CastObce/{id}/obec | Vráti obec, do ktorého CastObce patrí @SlovenskoRegisterAdries.CastObceApi | castObceControllerUlice | GET /CastObce/{id}/ulice | Vráti všetky ulice ktoré sa nachádzajú v CastObce @SlovenskoRegisterAdries.DefaultApi | searchControllerSearch | GET /search/{search} | @SlovenskoRegisterAdries.KrajApi | krajControllerGet | GET /Kraj | Vráti všetky kraje @SlovenskoRegisterAdries.KrajApi | krajControllerGetById | GET /Kraj/{id} | Vráti Kraj s príslušným identifikátorom @SlovenskoRegisterAdries.KrajApi | krajControllerOkresy | GET /Kraj/{id}/okresy | Vráti všetky okresy ktoré sa nachádzajú v Kraj @SlovenskoRegisterAdries.ObecApi | obecControllerBudovy | GET /Obec/{id}/budovy | Vráti všetky budovy ktoré sa nachádzajú v Obec @SlovenskoRegisterAdries.ObecApi | obecControllerCastiObce | GET /Obec/{id}/castiObce | Vráti všetky castiObce ktoré sa nachádzajú v Obec @SlovenskoRegisterAdries.ObecApi | obecControllerGet | GET /Obec | Vráti všetky obce @SlovenskoRegisterAdries.ObecApi | obecControllerGetById | GET /Obec/{id} | Vráti Obec s príslušným identifikátorom @SlovenskoRegisterAdries.ObecApi | obecControllerMestskeCasti | GET /Obec/{id}/mestskeCasti | Vráti všetky mestskeCasti ktoré sa nachádzajú v Obec @SlovenskoRegisterAdries.ObecApi | obecControllerOkres | GET /Obec/{id}/okres | Vráti okres, do ktorého Obec patrí @SlovenskoRegisterAdries.ObecApi | obecControllerUlice | GET /Obec/{id}/ulice | Vráti všetky ulice ktoré sa nachádzajú v Obec @SlovenskoRegisterAdries.OkresApi | okresControllerGet | GET /Okres | Vráti všetky okresy @SlovenskoRegisterAdries.OkresApi | okresControllerGetById | GET /Okres/{id} | Vráti Okres s príslušným identifikátorom @SlovenskoRegisterAdries.OkresApi | okresControllerKraj | GET /Okres/{id}/kraj | Vráti kraj, do ktorého Okres patrí @SlovenskoRegisterAdries.OkresApi | okresControllerObce | GET /Okres/{id}/obce | Vráti všetky obce ktoré sa nachádzajú v Okres @SlovenskoRegisterAdries.UlicaApi | ulicaControllerCastiObce | GET /Ulica/{id}/castiObce | Vráti všetky castiObce ktoré sa nachádzajú v Ulica @SlovenskoRegisterAdries.UlicaApi | ulicaControllerGet | GET /Ulica | Vráti všetky ulice @SlovenskoRegisterAdries.UlicaApi | ulicaControllerGetById | GET /Ulica/{id} | Vráti Ulica s príslušným identifikátorom @SlovenskoRegisterAdries.UlicaApi | ulicaControllerVchody | GET /Ulica/{id}/vchody | Vráti všetky vchody ktoré sa nachádzajú v Ulica @SlovenskoRegisterAdries.VchodApi | vchodControllerBudova | GET /Vchod/{id}/budova | Vráti budova, do ktorého Vchod patrí @SlovenskoRegisterAdries.VchodApi | vchodControllerByty | GET /Vchod/{id}/byty | Vráti všetky byty ktoré sa nachádzajú v Vchod @SlovenskoRegisterAdries.VchodApi | vchodControllerGet | GET /Vchod | Vráti všetky vchody @SlovenskoRegisterAdries.VchodApi | vchodControllerGetById | GET /Vchod/{id} | Vráti Vchod s príslušným identifikátorom @SlovenskoRegisterAdries.VchodApi | vchodControllerUlica | GET /Vchod/{id}/ulica | Vráti ulica, do ktorého Vchod patrí

Documentation for Models

• @SlovenskoRegisterAdries.BooleanFieldComparison
• @SlovenskoRegisterAdries.BudovaFilter
• @SlovenskoRegisterAdries.BudovaPaginated
• @SlovenskoRegisterAdries.BudovaSort
• @SlovenskoRegisterAdries.BytFilter
• @SlovenskoRegisterAdries.BytPaginated
• @SlovenskoRegisterAdries.BytSort
• @SlovenskoRegisterAdries.CastObceFilter
• @SlovenskoRegisterAdries.CastObcePaginated
• @SlovenskoRegisterAdries.CastObceSort
• @SlovenskoRegisterAdries.Kraj
• @SlovenskoRegisterAdries.KrajFilter
• @SlovenskoRegisterAdries.KrajPaginated
• @SlovenskoRegisterAdries.KrajSort
• @SlovenskoRegisterAdries.NumberFieldComparison
• @SlovenskoRegisterAdries.NumberFieldComparisonBetween
• @SlovenskoRegisterAdries.Obec
• @SlovenskoRegisterAdries.ObecFilter
• @SlovenskoRegisterAdries.ObecPaginated
• @SlovenskoRegisterAdries.ObecSort
• @SlovenskoRegisterAdries.Okres
• @SlovenskoRegisterAdries.OkresFilter
• @SlovenskoRegisterAdries.OkresPaginated
• @SlovenskoRegisterAdries.OkresSort
• @SlovenskoRegisterAdries.PaginationLinks
• @SlovenskoRegisterAdries.PaginationMeta
• @SlovenskoRegisterAdries.StringFieldComparison
• @SlovenskoRegisterAdries.UlicaFilter
• @SlovenskoRegisterAdries.UlicaPaginated
• @SlovenskoRegisterAdries.UlicaSort
• @SlovenskoRegisterAdries.VchodFilter
• @SlovenskoRegisterAdries.VchodPaginated
• @SlovenskoRegisterAdries.VchodSort

Documentation for Authorization

apiKeyHeader

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

apiKeyQuery

• Type: API key
• API key parameter name: api-key
• Location: URL query string