lu_api_documentation_template v1.0.1
lu_api_documentation_template
LuApiDocumentationTemplate - JavaScript client for lu_api_documentation_template Created by the DPS-group. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.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 lu_api_documentation_template --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 LuApiDocumentationTemplate = require('lu_api_documentation_template');
var api = new LuApiDocumentationTemplate.DatasetApi()
var id = "id_example"; // {String} ID of the dataset to get
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getDatasetByID(id, callback);
Documentation for API Endpoints
All URIs are relative to http://canmove-dev.ekol.lu.se:8088
Class | Method | HTTP request | Description |
---|---|---|---|
LuApiDocumentationTemplate.DatasetApi | getDatasetByID | GET /datasets/{id} | Get dataset by ID |
LuApiDocumentationTemplate.DatasetApi | getDatasetsBySearch | POST /datasets | Get datasets by search |
LuApiDocumentationTemplate.EventApi | getEventsByID | GET /events/{eventID} | Get event by ID |
LuApiDocumentationTemplate.EventApi | getEventsBySearch | POST /events | Get event by search |
LuApiDocumentationTemplate.OccurrenceApi | getOccurrencesByID | GET /occurrences/{occurrenceId} | Get occurrence by ID |
LuApiDocumentationTemplate.OccurrenceApi | getOccurrencesBySearch | POST /occurrences | Get occurrences by search |
Documentation for Models
- LuApiDocumentationTemplate.AssociatedMedia
- LuApiDocumentationTemplate.County
- LuApiDocumentationTemplate.Dataset
- LuApiDocumentationTemplate.DatasetFilter
- LuApiDocumentationTemplate.DateFilter
- LuApiDocumentationTemplate.DateFilterType
- LuApiDocumentationTemplate.Event
- LuApiDocumentationTemplate.EventDataset
- LuApiDocumentationTemplate.EventsFilter
- LuApiDocumentationTemplate.ExchangeObject
- LuApiDocumentationTemplate.GeographicsFilter
- LuApiDocumentationTemplate.GeographicsFilterArea
- LuApiDocumentationTemplate.LineGeometry
- LuApiDocumentationTemplate.LineGeometryGeometry
- LuApiDocumentationTemplate.LineOrPolygonQuery
- LuApiDocumentationTemplate.LineOrPolygonQueryFeatureLP
- LuApiDocumentationTemplate.LineOrPolygonQueryFeatureLPGeometry
- LuApiDocumentationTemplate.Location
- LuApiDocumentationTemplate.LocationGeneralized
- LuApiDocumentationTemplate.Methodology
- LuApiDocumentationTemplate.Municipality
- LuApiDocumentationTemplate.Occurrence
- LuApiDocumentationTemplate.OccurrenceFilter
- LuApiDocumentationTemplate.OneOfGeographicsFilterAreaGeographicArea
- LuApiDocumentationTemplate.OneOfLocationEmplacement
- LuApiDocumentationTemplate.OneOfLocationGeneralizedEmplacement
- LuApiDocumentationTemplate.Organisation
- LuApiDocumentationTemplate.OrganismVariable
- LuApiDocumentationTemplate.PointGeometry
- LuApiDocumentationTemplate.PointGeometryGeometry
- LuApiDocumentationTemplate.PointGeometryProperties
- LuApiDocumentationTemplate.PointOrBoundingBoxQuery
- LuApiDocumentationTemplate.PointOrBoundingBoxQueryFeaturePBB
- LuApiDocumentationTemplate.PointOrBoundingBoxQueryFeaturePBBGeometry
- LuApiDocumentationTemplate.PolygonGeometry
- LuApiDocumentationTemplate.PolygonGeometryGeometry
- LuApiDocumentationTemplate.Taxon
- LuApiDocumentationTemplate.TaxonFilter
- LuApiDocumentationTemplate.WeatherMeasuring
- LuApiDocumentationTemplate.WeatherVariable
Documentation for Authorization
All endpoints do not require authorization.