crowdflow_attendee_api

CrowdflowAttendeeApi - JavaScript client for crowdflow_attendee_api CrowdFlow API for attendee application / website

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.2.0
Package version: 1.2.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_attendee_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_attendee_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 CrowdflowAttendeeApi = require('crowdflow_attendee_api');


var api = new CrowdflowAttendeeApi.EventApi()
api.getEvent().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://virtserver.swaggerhub.com/jaspervrints8/Crowdflow/1.0.0

Class	Method	HTTP request	Description
CrowdflowAttendeeApi.EventApi	getEvent	GET /event	Get active event
CrowdflowAttendeeApi.OptimalQueueApi	getOptimalQueue	GET /optimal	Get optimal queue in event based on latidude and longitude
CrowdflowAttendeeApi.OptimalQueueApi	getOptimalQueueZone	GET /optimal/zone	Get optimal queue given the column and row index of the zone

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.