Lpo_rest NPM | npm.io

lpo_rest

LpoRest - JavaScript client for lpo_rest Service web pour gérer les nichoirs d'un Adhérent LPO This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.14
Package version: 1.0.14
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 lpo_rest --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/lpo_rest then install it via:

    npm install YOUR_USERNAME/lpo_rest --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 LpoRest = require('lpo_rest');

var defaultClient = LpoRest.ApiClient.instance;

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

var api = new LpoRest.NichoirApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.byProprietaireNichoirCollection(callback);

Documentation for API Endpoints

All URIs are relative to http://192.168.1.10:8080/web/app_dev.php

Class	Method	HTTP request	Description
LpoRest.NichoirApi	byProprietaireNichoirCollection	GET /nichoir/byProprietaire	Retrieves the collection of Nichoir resources.
LpoRest.NichoirApi	deleteNichoirItem	DELETE /nichoirs/{id}	Removes the Nichoir resource.
LpoRest.NichoirApi	getNichoirCollection	GET /nichoirs	Retrieves the collection of Nichoir resources.
LpoRest.NichoirApi	getNichoirItem	GET /nichoirs/{id}	Retrieves a Nichoir resource.
LpoRest.NichoirApi	postNichoirCollection	POST /nichoirs	Creates a Nichoir resource.
LpoRest.NichoirApi	putNichoirItem	PUT /nichoirs/{id}	Replaces the Nichoir resource.
LpoRest.OiseauApi	deleteOiseauItem	DELETE /oiseaus/{id}	Removes the Oiseau resource.
LpoRest.OiseauApi	getOiseauCollection	GET /oiseaus	Retrieves the collection of Oiseau resources.
LpoRest.OiseauApi	getOiseauItem	GET /oiseaus/{id}	Retrieves a Oiseau resource.
LpoRest.OiseauApi	postOiseauCollection	POST /oiseaus	Creates a Oiseau resource.
LpoRest.OiseauApi	putOiseauItem	PUT /oiseaus/{id}	Replaces the Oiseau resource.
LpoRest.PhotooiseauApi	deletePhotooiseauItem	DELETE /photooiseaus/{id}	Removes the Photooiseau resource.
LpoRest.PhotooiseauApi	getPhotooiseauCollection	GET /photooiseaus	Retrieves the collection of Photooiseau resources.
LpoRest.PhotooiseauApi	getPhotooiseauItem	GET /photooiseaus/{id}	Retrieves a Photooiseau resource.
LpoRest.PhotooiseauApi	postPhotooiseauCollection	POST /photooiseaus	Creates a Photooiseau resource.
LpoRest.PhotooiseauApi	putPhotooiseauItem	PUT /photooiseaus/{id}	Replaces the Photooiseau resource.
LpoRest.ProprietaireApi	deleteProprietaireItem	DELETE /proprietaires/{id}	Removes the Proprietaire resource.
LpoRest.ProprietaireApi	getProprietaireCollection	GET /proprietaires	Retrieves the collection of Proprietaire resources.
LpoRest.ProprietaireApi	getProprietaireItem	GET /proprietaires/{id}	Retrieves a Proprietaire resource.
LpoRest.ProprietaireApi	postProprietaireCollection	POST /proprietaires	Creates a Proprietaire resource.
LpoRest.ProprietaireApi	putProprietaireItem	PUT /proprietaires/{id}	Replaces the Proprietaire resource.