1.0.0 • Published 5 years ago

vaccination_service_specification v1.0.0

Weekly downloads
1
License
Unlicense
Repository
-
Last release
5 years ago

vaccination_service_specification

VaccinationServiceSpecification - JavaScript client for vaccination_service_specification Codegen for vaccination service This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.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 vaccination_service_specification --save
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

Finally, switch to the directory you want to use your vaccination_service_specification from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('vaccination_service_specification') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 VaccinationServiceSpecification = require('vaccination_service_specification');

var api = new VaccinationServiceSpecification.VaccinationApi()
var vaccinationRequestBody = new VaccinationServiceSpecification.VaccinationRequestBody(); // {VaccinationRequestBody} Vaccination body that need to be saved

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addNewVaccination(vaccinationRequestBody, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
VaccinationServiceSpecification.VaccinationApiaddNewVaccinationPOST /vaccinationAdd new Vaccination
VaccinationServiceSpecification.VaccinationApigetVaccinationGET /vaccination/{id}Retrieves Vaccination by id
VaccinationServiceSpecification.VaccinationApigetVaccinationsGET /vaccinationRetrieves Vaccinations by person
VaccinationServiceSpecification.VaccinationApiupdateVaccinationStatusPUT /vaccination/{id}/statusUpdates Vaccination Status
VaccinationServiceSpecification.VaccineApigetVaccinesGET /vaccineRetrieves Vaccines

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.