kunta-api-client

KuntaApiClient - JavaScript client for kunta-api-client Solution to combine municipality services under single API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Package version: 0.0.141
• Build date: 2019-07-08T18:11:45.976+03:00
• Build package: class io.swagger.codegen.languages.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 kunta-api-client --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.

Getting Started

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

var KuntaApiClient = require('kunta-api-client');

var defaultClient = KuntaApiClient.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new KuntaApiClient.AnnouncementsApi()

var organizationId = "organizationId_example"; // {String} Organization id

var announcementId = "announcementId_example"; // {String} Announcement id

api.findOrganizationAnnouncement(organizationId, announcementId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://demo.kuntaapi.fi/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- KuntaApiClient.AnnouncementsApi | findOrganizationAnnouncement | GET /organizations/{organizationId}/announcements/{announcementId} | Finds an organizations announcement KuntaApiClient.AnnouncementsApi | listOrganizationAnnouncements | GET /organizations/{organizationId}/announcements | Lists organizations announcements KuntaApiClient.BannersApi | findOrganizationBanner | GET /organizations/{organizationId}/banners/{bannerId} | Finds organizations banner KuntaApiClient.BannersApi | findOrganizationBannerImage | GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId} | Returns a single organiztion banner image KuntaApiClient.BannersApi | getOrganizationBannerImageData | GET /organizations/{organizationId}/banners/{bannerId}/images/{imageId}/data | Returns an organization banner image data KuntaApiClient.BannersApi | listOrganizationBannerImages | GET /organizations/{organizationId}/banners/{bannerId}/images | Returns a list of organization banner images KuntaApiClient.BannersApi | listOrganizationBanners | GET /organizations/{organizationId}/banners | Lists organizations banners KuntaApiClient.CodesApi | findCode | GET /codes/{codeId} | Finds a code KuntaApiClient.CodesApi | listCodes | GET /codes | Lists codes KuntaApiClient.ContactsApi | findOrganizationContact | GET /organizations/{organizationId}/contacts/{contactId} | Finds an organizations contact KuntaApiClient.ContactsApi | listOrganizationContacts | GET /organizations/{organizationId}/contacts | Lists organizations contacts KuntaApiClient.ElectronicChannelsApi | findServiceElectronicChannel | GET /services/{serviceId}/electronicChannels/{electronicChannelId} | finds ElectronicChannel by electronicChannelId KuntaApiClient.ElectronicChannelsApi | listServiceElectronicChannels | GET /services/{serviceId}/electronicChannels | Lists ElectronicChannels by serviceId KuntaApiClient.ElectronicServiceChannelsApi | findElectronicServiceChannel | GET /electronicServiceChannels/{electronicServiceChannelId} | Finds an electronic service channel by id KuntaApiClient.ElectronicServiceChannelsApi | listElectronicServiceChannels | GET /electronicServiceChannels | Lists electronic service channels KuntaApiClient.ElectronicServiceChannelsApi | updateElectronicServiceChannel | PUT /electronicServiceChannels/{electronicServiceChannelId} | Updates a channel KuntaApiClient.EmergenciesApi | findOrganizationEmergency | GET /organizations/{organizationId}/emergencies/{emergencyId} | Returns organizations emergency by id KuntaApiClient.EmergenciesApi | listOrganizationEmergencies | GET /organizations/{organizationId}/emergencies | Lists organizations emergencies KuntaApiClient.EnvironmentalWarningsApi | findOrganizationEnvironmentalWarning | GET /organizations/{organizationId}/environmentalWarnings/{environmentalWarningId} | Returns organizations environmental warning by id KuntaApiClient.EnvironmentalWarningsApi | listOrganizationEnvironmentalWarnings | GET /organizations/{organizationId}/environmentalWarnings | Lists organizations environmentalWarnings KuntaApiClient.EventsApi | findOrganizationEvent | GET /organizations/{organizationId}/events/{eventId} | Returns organizations event by id KuntaApiClient.EventsApi | findOrganizationEventImage | GET /organizations/{organizationId}/events/{eventId}/images/{imageId} | Returns an event image KuntaApiClient.EventsApi | getOrganizationEventImageData | GET /organizations/{organizationId}/events/{eventId}/images/{imageId}/data | Returns an event image data KuntaApiClient.EventsApi | listOrganizationEventImages | GET /organizations/{organizationId}/events/{eventId}/images | Returns list of event images KuntaApiClient.EventsApi | listOrganizationEvents | GET /organizations/{organizationId}/events | Lists organizations events KuntaApiClient.FilesApi | deleteOrganizationFile | DELETE /organizations/{organizationId}/files/{fileId} | Deletes an organization file KuntaApiClient.FilesApi | findOrganizationFile | GET /organizations/{organizationId}/files/{fileId} | Finds organizations file KuntaApiClient.FilesApi | getOrganizationFileData | GET /organizations/{organizationId}/files/{fileId}/data | Returns an organization file data KuntaApiClient.FilesApi | listOrganizationFiles | GET /organizations/{organizationId}/files | Lists organizations files KuntaApiClient.FragmentsApi | findOrganizationFragment | GET /organizations/{organizationId}/fragments/{fragmentId} | Finds organizations page fragment KuntaApiClient.FragmentsApi | listOrganizationFragments | GET /organizations/{organizationId}/fragments | Lists organizations page fragments KuntaApiClient.IncidentsApi | findOrganizationIncident | GET /organizations/{organizationId}/incidents/{incidentId} | Returns organizations incident by id KuntaApiClient.IncidentsApi | listOrganizationIncidents | GET /organizations/{organizationId}/incidents | Lists organizations incidents KuntaApiClient.JobsApi | findOrganizationJob | GET /organizations/{organizationId}/jobs/{jobId} | Finds organizations job KuntaApiClient.JobsApi | listOrganizationJobs | GET /organizations/{organizationId}/jobs | Lists organizations jobs KuntaApiClient.MenusApi | findOrganizationMenu | GET /organizations/{organizationId}/menus/{menuId} | Finds organizations menu KuntaApiClient.MenusApi | findOrganizationMenuItem | GET /organizations/{organizationId}/menus/{menuId}/items/{menuItemId} | Finds organization menu item KuntaApiClient.MenusApi | listOrganizationMenuItems | GET /organizations/{organizationId}/menus/{menuId}/items | Lists organizations menu items KuntaApiClient.MenusApi | listOrganizationMenus | GET /organizations/{organizationId}/menus | Lists organizations menus KuntaApiClient.NewsApi | findOrganizationNewsArticle | GET /organizations/{organizationId}/news/{newsArticleId} | Finds organizations news article KuntaApiClient.NewsApi | findOrganizationNewsArticleImage | GET /organizations/{organizationId}/news/{newsArticleId}/images/{imageId} | Returns an news article image KuntaApiClient.NewsApi | getOrganizationNewsArticleImageData | GET /organizations/{organizationId}/news/{newsArticleId}/images/{imageId}/data | Returns a news article image data KuntaApiClient.NewsApi | listOrganizationNews | GET /organizations/{organizationId}/news | Lists organizations news KuntaApiClient.NewsApi | listOrganizationNewsArticleImages | GET /organizations/{organizationId}/news/{newsArticleId}/images | Returns list of news article images KuntaApiClient.OrganizationsApi | findOrganization | GET /organizations/{organizationId} | Find organization KuntaApiClient.OrganizationsApi | listOrganizations | GET /organizations | List organizations KuntaApiClient.PagesApi | deleteOrganizationPage | DELETE /organizations/{organizationId}/pages/{pageId} | Deletes an organizations page KuntaApiClient.PagesApi | findOrganizationPage | GET /organizations/{organizationId}/pages/{pageId} | Finds organizations page KuntaApiClient.PagesApi | findOrganizationPageContent | GET /organizations/{organizationId}/pages/{pageId}/content | Returns organizations page content in all available languages KuntaApiClient.PagesApi | findOrganizationPageImage | GET /organizations/{organizationId}/pages/{pageId}/images/{imageId} | Returns a single organiztion page image KuntaApiClient.PagesApi | getOrganizationPageImageData | GET /organizations/{organizationId}/pages/{pageId}/images/{imageId}/data | Returns an organization page image data KuntaApiClient.PagesApi | listOrganizationPageImages | GET /organizations/{organizationId}/pages/{pageId}/images | Returns a list of organization page images KuntaApiClient.PagesApi | listOrganizationPages | GET /organizations/{organizationId}/pages | Lists organizations pages KuntaApiClient.PhoneChannelsApi | findServicePhoneChannel | GET /services/{serviceId}/phoneChannels/{phoneChannelId} | finds PhoneChannel by phoneChannelId KuntaApiClient.PhoneChannelsApi | listServicePhoneChannels | GET /services/{serviceId}/phoneChannels | Lists PhoneChannels by serviceId KuntaApiClient.PhoneServiceChannelsApi | findPhoneServiceChannel | GET /phoneServiceChannels/{phoneServiceChannelId} | Finds a phone service channel by id KuntaApiClient.PhoneServiceChannelsApi | listPhoneServiceChannels | GET /phoneServiceChannels | Lists phone service channels KuntaApiClient.PhoneServiceChannelsApi | updatePhoneServiceChannel | PUT /phoneServiceChannels/{phoneServiceChannelId} | Updates a channel KuntaApiClient.PrintableFormChannelsApi | findServicePrintableFormChannel | GET /services/{serviceId}/printableFormChannels/{printableFormChannelId} | finds PrintableFormChannel by printableFormChannelId KuntaApiClient.PrintableFormChannelsApi | listServicePrintableFormChannels | GET /services/{serviceId}/printableFormChannels | Lists PrintableFormChannels by serviceId KuntaApiClient.PrintableFormServiceChannelsApi | findPrintableFormServiceChannel | GET /printableFormServiceChannels/{printableFormServiceChannelId} | Finds a printable form service channel KuntaApiClient.PrintableFormServiceChannelsApi | listPrintableFormServiceChannels | GET /printableFormServiceChannels | Lists printable form service channels KuntaApiClient.PrintableFormServiceChannelsApi | updatePrintableFormServiceChannel | PUT /printableFormServiceChannels/{printableFormServiceChannelId} | Updates a channel KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportAgency | GET /organizations/{organizationId}/transportAgencies/{agencyId} | Finds an organizations public transport agency KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportRoute | GET /organizations/{organizationId}/transportRoutes/{routeId} | Finds an organizations public transport route KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportSchedule | GET /organizations/{organizationId}/transportSchedules/{scheduleId} | Finds organizations public transport schedule KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportStop | GET /organizations/{organizationId}/transportStops/{stopId} | Finds a stop of organizations public transport route KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportStopTime | GET /organizations/{organizationId}/transportStopTimes/{stopTimeId} | Finds organizations public transport stopTime KuntaApiClient.PublicTransportApi | findOrganizationPublicTransportTrip | GET /organizations/{organizationId}/transportTrips/{tripId} | Finds organizations public transport trip KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportAgencies | GET /organizations/{organizationId}/transportAgencies | Lists organizations public transport agencies KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportRoutes | GET /organizations/{organizationId}/transportRoutes | Lists organizations public transport routes KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportSchedules | GET /organizations/{organizationId}/transportSchedules | Lists schedules of organization's public transport schedules KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportStopTimes | GET /organizations/{organizationId}/transportStopTimes | Lists stopTimes of organization's public transport stopTimes KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportStops | GET /organizations/{organizationId}/transportStops | Lists organizations public transport stops KuntaApiClient.PublicTransportApi | listOrganizationPublicTransportTrips | GET /organizations/{organizationId}/transportTrips | Lists trips of organization's public transport trips KuntaApiClient.ServiceChannelsApi | findElectronicServiceChannel | GET /electronicServiceChannels/{electronicServiceChannelId} | Finds an electronic service channel by id KuntaApiClient.ServiceChannelsApi | findPhoneServiceChannel | GET /phoneServiceChannels/{phoneServiceChannelId} | Finds a phone service channel by id KuntaApiClient.ServiceChannelsApi | findPrintableFormServiceChannel | GET /printableFormServiceChannels/{printableFormServiceChannelId} | Finds a printable form service channel KuntaApiClient.ServiceChannelsApi | findServiceLocationServiceChannel | GET /serviceLocationServiceChannels/{serviceLocationServiceChannelId} | Finds a service location service by id KuntaApiClient.ServiceChannelsApi | findWebPageServiceChannel | GET /webPageServiceChannels/{webPageServiceChannelId} | Finds a web page service channel by id KuntaApiClient.ServiceChannelsApi | listElectronicServiceChannels | GET /electronicServiceChannels | Lists electronic service channels KuntaApiClient.ServiceChannelsApi | listPhoneServiceChannels | GET /phoneServiceChannels | Lists phone service channels KuntaApiClient.ServiceChannelsApi | listPrintableFormServiceChannels | GET /printableFormServiceChannels | Lists printable form service channels KuntaApiClient.ServiceChannelsApi | listServiceLocationServiceChannels | GET /serviceLocationServiceChannels | Lists service location service channels KuntaApiClient.ServiceChannelsApi | listWebPageServiceChannels | GET /webPageServiceChannels | Lists web page service channels KuntaApiClient.ServiceChannelsApi | updateElectronicServiceChannel | PUT /electronicServiceChannels/{electronicServiceChannelId} | Updates a channel KuntaApiClient.ServiceChannelsApi | updatePhoneServiceChannel | PUT /phoneServiceChannels/{phoneServiceChannelId} | Updates a channel KuntaApiClient.ServiceChannelsApi | updatePrintableFormServiceChannel | PUT /printableFormServiceChannels/{printableFormServiceChannelId} | Updates a channel KuntaApiClient.ServiceChannelsApi | updateServiceLocationServiceChannel | PUT /serviceLocationServiceChannels/{serviceLocationServiceChannelId} | Updates a service location channel KuntaApiClient.ServiceChannelsApi | updateWebPageServiceChannel | PUT /webPageServiceChannels/{webPageServiceChannelId} | Updates a channel KuntaApiClient.ServiceLocationChannelsApi | findServiceServiceLocationChannel | GET /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} | finds ServiceLocationChannel by serviceLocationChannelId KuntaApiClient.ServiceLocationChannelsApi | listServiceServiceLocationChannels | GET /services/{serviceId}/serviceLocationChannels | Lists ServiceLocationChannels by serviceId KuntaApiClient.ServiceLocationServiceChannelsApi | findServiceLocationServiceChannel | GET /serviceLocationServiceChannels/{serviceLocationServiceChannelId} | Finds a service location service by id KuntaApiClient.ServiceLocationServiceChannelsApi | listServiceLocationServiceChannels | GET /serviceLocationServiceChannels | Lists service location service channels KuntaApiClient.ServiceLocationServiceChannelsApi | updateServiceLocationServiceChannel | PUT /serviceLocationServiceChannels/{serviceLocationServiceChannelId} | Updates a service location channel KuntaApiClient.ServicesApi | createService | POST /services | Create service KuntaApiClient.ServicesApi | findService | GET /services/{serviceId} | Finds a service by id KuntaApiClient.ServicesApi | findServiceElectronicChannel | GET /services/{serviceId}/electronicChannels/{electronicChannelId} | finds ElectronicChannel by electronicChannelId KuntaApiClient.ServicesApi | findServicePhoneChannel | GET /services/{serviceId}/phoneChannels/{phoneChannelId} | finds PhoneChannel by phoneChannelId KuntaApiClient.ServicesApi | findServicePrintableFormChannel | GET /services/{serviceId}/printableFormChannels/{printableFormChannelId} | finds PrintableFormChannel by printableFormChannelId KuntaApiClient.ServicesApi | findServiceServiceLocationChannel | GET /services/{serviceId}/serviceLocationChannels/{serviceLocationChannelId} | finds ServiceLocationChannel by serviceLocationChannelId KuntaApiClient.ServicesApi | findServiceWebPageChannel | GET /services/{serviceId}/webPageChannels/{webPageChannelId} | finds WebPageChannel by webPageChannelId KuntaApiClient.ServicesApi | listServiceElectronicChannels | GET /services/{serviceId}/electronicChannels | Lists ElectronicChannels by serviceId KuntaApiClient.ServicesApi | listServicePhoneChannels | GET /services/{serviceId}/phoneChannels | Lists PhoneChannels by serviceId KuntaApiClient.ServicesApi | listServicePrintableFormChannels | GET /services/{serviceId}/printableFormChannels | Lists PrintableFormChannels by serviceId KuntaApiClient.ServicesApi | listServiceServiceLocationChannels | GET /services/{serviceId}/serviceLocationChannels | Lists ServiceLocationChannels by serviceId KuntaApiClient.ServicesApi | listServiceWebPageChannels | GET /services/{serviceId}/webPageChannels | Lists WebPageChannels by serviceId KuntaApiClient.ServicesApi | listServices | GET /services | Service list KuntaApiClient.ServicesApi | updateService | PUT /services/{serviceId} | Updates service KuntaApiClient.SettingsApi | createOrganizationSetting | POST /organizations/{organizationId}/settings/ | Creates organization setting KuntaApiClient.SettingsApi | deleteOrganizationSetting | DELETE /organizations/{organizationId}/settings/{settingId} | Deletes an organization setting KuntaApiClient.SettingsApi | findOrganizationSetting | GET /organizations/{organizationId}/settings/{settingId} | Finds organizations setting KuntaApiClient.SettingsApi | listOrganizationSettings | GET /organizations/{organizationId}/settings/ | Lists organizations settings KuntaApiClient.SettingsApi | updateOrganizationSetting | PUT /organizations/{organizationId}/settings/{settingId} | Updates an organization setting KuntaApiClient.ShortlinksApi | findOrganizationShortlink | GET /organizations/{organizationId}/shortlinks/{shortlinkId} | Finds organization shortlink KuntaApiClient.ShortlinksApi | listOrganizationShortlinks | GET /organizations/{organizationId}/shortlinks | Lists organizations shortlinks KuntaApiClient.TilesApi | findOrganizationTile | GET /organizations/{organizationId}/tiles/{tileId} | Finds organizations tile KuntaApiClient.TilesApi | findOrganizationTileImage | GET /organizations/{organizationId}/tiles/{tileId}/images/{imageId} | Returns a single organiztion tile image KuntaApiClient.TilesApi | getOrganizationTileImageData | GET /organizations/{organizationId}/tiles/{tileId}/images/{imageId}/data | Returns an organization tile image data KuntaApiClient.TilesApi | listOrganizationTileImages | GET /organizations/{organizationId}/tiles/{tileId}/images | Returns a list of organization tile images KuntaApiClient.TilesApi | listOrganizationTiles | GET /organizations/{organizationId}/tiles | Lists organizations tiles KuntaApiClient.WebPageChannelsApi | findServiceWebPageChannel | GET /services/{serviceId}/webPageChannels/{webPageChannelId} | finds WebPageChannel by webPageChannelId KuntaApiClient.WebPageChannelsApi | listServiceWebPageChannels | GET /services/{serviceId}/webPageChannels | Lists WebPageChannels by serviceId KuntaApiClient.WebPageServiceChannelsApi | findWebPageServiceChannel | GET /webPageServiceChannels/{webPageServiceChannelId} | Finds a web page service channel by id KuntaApiClient.WebPageServiceChannelsApi | listWebPageServiceChannels | GET /webPageServiceChannels | Lists web page service channels KuntaApiClient.WebPageServiceChannelsApi | updateWebPageServiceChannel | PUT /webPageServiceChannels/{webPageServiceChannelId} | Updates a channel

Documentation for Models

• KuntaApiClient.AccessibilityContactInfo
• KuntaApiClient.AccessibilitySentence
• KuntaApiClient.AccessibilitySentenceValue
• KuntaApiClient.Address
• KuntaApiClient.AddressEntrance
• KuntaApiClient.Agency
• KuntaApiClient.Announcement
• KuntaApiClient.Area
• KuntaApiClient.Attachment
• KuntaApiClient.BadRequest
• KuntaApiClient.Banner
• KuntaApiClient.Code
• KuntaApiClient.CodeExtra
• KuntaApiClient.Contact
• KuntaApiClient.ContactPhone
• KuntaApiClient.ContactStatus
• KuntaApiClient.Coordinate
• KuntaApiClient.Coordinates
• KuntaApiClient.DailyOpeningTime
• KuntaApiClient.ElectronicServiceChannel
• KuntaApiClient.Email
• KuntaApiClient.Emergency
• KuntaApiClient.EmergencySource
• KuntaApiClient.EnvironmentalWarning
• KuntaApiClient.Event
• KuntaApiClient.FileDef
• KuntaApiClient.Forbidden
• KuntaApiClient.Fragment
• KuntaApiClient.Incident
• KuntaApiClient.InternalServerError
• KuntaApiClient.Job
• KuntaApiClient.Law
• KuntaApiClient.LocalizedValue
• KuntaApiClient.Menu
• KuntaApiClient.MenuItem
• KuntaApiClient.Municipality
• KuntaApiClient.NameTypeByLanguage
• KuntaApiClient.NewsArticle
• KuntaApiClient.NotFound
• KuntaApiClient.NotImplemented
• KuntaApiClient.OntologyItem
• KuntaApiClient.Organization
• KuntaApiClient.OrganizationService
• KuntaApiClient.OrganizationSetting
• KuntaApiClient.Page
• KuntaApiClient.PageMeta
• KuntaApiClient.Phone
• KuntaApiClient.PhoneServiceChannel
• KuntaApiClient.PrintableFormServiceChannel
• KuntaApiClient.Route
• KuntaApiClient.Schedule
• KuntaApiClient.ScheduleException
• KuntaApiClient.Service
• KuntaApiClient.ServiceChannelAttachment
• KuntaApiClient.ServiceHour
• KuntaApiClient.ServiceLocationServiceChannel
• KuntaApiClient.ServiceOrganization
• KuntaApiClient.ServiceVoucher
• KuntaApiClient.Shortlink
• KuntaApiClient.Stop
• KuntaApiClient.StopTime
• KuntaApiClient.Tile
• KuntaApiClient.Trip
• KuntaApiClient.WebPage
• KuntaApiClient.WebPageServiceChannel

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication