crowdflow_organiser_api

CrowdflowOrganiserApi - JavaScript client for crowdflow_organiser_api CrowdFlow Event API for organisers

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.8.0
• Package version: 1.8.0
• Build package: org.openapitools.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 crowdflow_organiser_api --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 crowdflow_organiser_api 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 CrowdflowOrganiserApi = require('crowdflow_organiser_api');


var api = new CrowdflowOrganiserApi.AuthApi()
var username = "username_example"; // {String} The user name for login
var password = "password_example"; // {String} The password for login in clear text
api.generateToken(username, password).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 http://admin.crowdflow.idlab.ugent.be:30083

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CrowdflowOrganiserApi.AuthApi | generateToken | GET /auth/login | Log in and return JWT token CrowdflowOrganiserApi.AuthApi | getSecret | GET /auth/secret | Return secret string CrowdflowOrganiserApi.AuthApi | getUserInfo | GET /auth/me | Return decoded token CrowdflowOrganiserApi.EventApi | addEvent | POST /event | Add a new event to the store CrowdflowOrganiserApi.EventApi | deleteEvent | DELETE /event/{eventId} | Deletes an event CrowdflowOrganiserApi.EventApi | getCurrentEvent | GET /current-event | Get current active event CrowdflowOrganiserApi.EventApi | getEventById | GET /event/{eventId} | Find event by ID CrowdflowOrganiserApi.EventApi | getEvents | GET /event | Get all events CrowdflowOrganiserApi.EventApi | updateEvent | PUT /event/{eventId} | Update an existing event CrowdflowOrganiserApi.EventApi | updateStateEvent | PUT /event/{eventId}/state | Update the state of an event

Documentation for Models

• CrowdflowOrganiserApi.Camera
• CrowdflowOrganiserApi.CameraCorners
• CrowdflowOrganiserApi.Coordinate
• CrowdflowOrganiserApi.Event
• CrowdflowOrganiserApi.EventMap
• CrowdflowOrganiserApi.EventMapWorldCoordinates
• CrowdflowOrganiserApi.GeoCoordinate
• CrowdflowOrganiserApi.Poi
• CrowdflowOrganiserApi.Queue
• CrowdflowOrganiserApi.Terminal
• CrowdflowOrganiserApi.UserInfo
• CrowdflowOrganiserApi.Zone

Documentation for Authorization

jwt

• Type: Bearer authentication (JWT)