opendata_ytj_api

OpendataYtjApi - JavaScript client for opendata_ytj_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 2.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

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 opendata_ytj_api --save

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 OpendataYtjApi = require('opendata_ytj_api');

var api = new OpendataYtjApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllCompanies(callback);

Documentation for API Endpoints

All URIs are relative to https://avoindata.prh.fi/opendata-ytj-api/v3

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- OpendataYtjApi.DefaultApi | getAllCompanies | GET /all_companies | Hae kaikki kaupparekisterissä olevat ja vireillä olevat yritykset JSON tiedostona (päivitetään kerran päivässä) OpendataYtjApi.DefaultApi | getCompanies | GET /companies | Hae yrityksiä toiminimen, postitoimipaikan Y-tunnuksen tai yritysmuodon perusteella OpendataYtjApi.DefaultApi | getDescription | GET /description | Hae koodiston tiedot OpendataYtjApi.DefaultApi | getPostCodes | GET /post_codes | Hae postikoodiston tiedot

Documentation for Models

• OpendataYtjApi.Address
• OpendataYtjApi.Company
• OpendataYtjApi.CompanyBusinessId
• OpendataYtjApi.CompanyEuId
• OpendataYtjApi.CompanyForm
• OpendataYtjApi.CompanyMainBusinessLine
• OpendataYtjApi.CompanyResult
• OpendataYtjApi.CompanySituation
• OpendataYtjApi.CompanyWebsite
• OpendataYtjApi.DescriptionEntry
• OpendataYtjApi.ErrorResponse
• OpendataYtjApi.PostOffice
• OpendataYtjApi.PostOfficeEntry
• OpendataYtjApi.RegisterName
• OpendataYtjApi.RegisteredEntry
• OpendataYtjApi.Source

Documentation for Authorization

All endpoints do not require authorization.