clive-api v1.0.4

clive-api

CliveApi - JavaScript client for clive-api Clive API This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.4
• Package version: 1.0.4
• Build date: 2016-06-21T21:30:06.828-04:00
• Build package: class 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 clive-api --save

git

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

npm install YOUR_USERNAME/clive-api --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 CliveApi = require('clive-api');

var api = new CliveApi.DefaultApi()

var companyNumber = "companyNumber_example"; // {String} Unique company number with prefixed zeros.


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

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/

Documentation for Models

• CliveApi.CompanyBrief
• CliveApi.CompanyOfficer
• CliveApi.CompanySearchResults
• CliveApi.CompanySummary

Documentation for Authorization

All endpoints do not require authorization.