README

linkedevents-client

LinkedeventsClient - JavaScript client for linkedevents-client Linked Events provides categorized data on events and places using JSON-LD format. Events can be searched by date and location. Location can be exact address or larger area such as neighbourhood or borough JSON-LD format is streamlined using include mechanism. API users can request that certain fields are included directly into the result, instead of being hyperlinks to objects. Several fields are multilingual. These are implemented as object with each language variant as property. In this specification each multilingual field has (fi,sv,en) property triplet as example. This SDK is automatically generated by the Swagger Codegen project:

API version: v1
Package version: 0.0.23
Build package: 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 linkedevents-client --save

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

Finally, switch to the directory you want to use your linkedevents-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('linkedevents-client') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 LinkedeventsClient = require('linkedevents-client');

var api = new LinkedeventsClient.EventApi()

var opts = { 
  'eventObject': new LinkedeventsClient.Event() // {Event} 
};
api.eventCreate(opts).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://api.hel.fi/linkedevents/v1

Class	Method	HTTP request	Description
LinkedeventsClient.EventApi	eventCreate	POST /event/	Create a new event
LinkedeventsClient.EventApi	eventDelete	DELETE /event/{id}/	Delete an event
LinkedeventsClient.EventApi	eventList	GET /event/	Return a list of events
LinkedeventsClient.EventApi	eventRetrieve	GET /event/{id}/	Retrieve single event by id
LinkedeventsClient.EventApi	eventUpdate	PUT /event/{id}/	Update an event
LinkedeventsClient.FilterApi	keywordCreate	POST /keyword/	Creates new keyword
LinkedeventsClient.FilterApi	keywordDelete	DELETE /keyword/{id}/	Delete a keyword
LinkedeventsClient.FilterApi	keywordList	GET /keyword/	Returns a list of keywords used for describing events
LinkedeventsClient.FilterApi	keywordRetrieve	GET /keyword/{id}/	Return information for single keyword
LinkedeventsClient.FilterApi	keywordSetList	GET /keyword_set/	Return as list of keyword_sets for grouping keywords
LinkedeventsClient.FilterApi	keywordSetRetrieve	GET /keyword_set/{id}	Return information about single keyword_set
LinkedeventsClient.FilterApi	keywordUpdate	PUT /keyword/{id}/	Update a keyword
LinkedeventsClient.FilterApi	placeCreate	POST /place/	Creates new place
LinkedeventsClient.FilterApi	placeDelete	DELETE /place/{id}/	Delete a place
LinkedeventsClient.FilterApi	placeList	GET /place/	Returns list of places used for describing events
LinkedeventsClient.FilterApi	placeRetrieve	GET /place/{id}/	Return information for single place
LinkedeventsClient.FilterApi	placeUpdate	PUT /place/{id}/	Update a place
LinkedeventsClient.ImageApi	imageCreate	POST /image/	Create a new image
LinkedeventsClient.ImageApi	imageList	GET /image/	Returns a list of images
LinkedeventsClient.ImageApi	imageRetrieve	GET /image/{id}/	Return information for single image
LinkedeventsClient.ImageApi	imageUpdate	PUT /image/{id}/	Update an image
LinkedeventsClient.LanguageApi	languageList	GET /language/	Return a list of languages used for describing events
LinkedeventsClient.LanguageApi	languageRetrieve	GET /language/{id}/	Return information for single language
LinkedeventsClient.SearchApi	eventSearch	GET /search/	Search through events and places

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Usage no npm install needed!