vet_proof_external_tools_api

v1.2.1

Published

a month ago

Das VetProof-Gateway dient zur automatischen Verwendung der Funktionen von VetProof von einer Client-Anwendung aus. Die hier beschriebene Schnittstelle ist als vorläufig zu betrachten und kann Änderungen und Erweiterungen unterliegen. Als Technologie für

Downloads

0High
0Medium
0Low

leoitdev

vet_proof_external_tools_api

VetProofExternalToolsApi - JavaScript client for vet_proof_external_tools_api Das VetProof-Gateway dient zur automatischen Verwendung der Funktionen von VetProof von einer Client-Anwendung aus. Die hier beschriebene Schnittstelle ist als vorläufig zu betrachten und kann Änderungen und Erweiterungen unterliegen.

Als Technologie für die Kommunikation wurde REST gewählt. Damit wird ein moderner Standard genutzt, der heute nahezu auf jedem Betriebssystem und mit fast jeder Programmiersprache verwendet werden kann.

Falls Sie schon mit der SOAP-Schnittstelle gearbeitet haben, finden Sie im <a href="yaml/migration-vetproof.html" target="_blank">Migration Guide eine Hilfe zum Umstieg zur neuen REST-Schnittstelle.

Technische Themen wie Sicherheit und Datenstrukturen werden ebenfalls im <a href="yaml/migration-vetproof.html" target="_blank">Migration Guide behandelt.

Die Versionshistorie finden Sie im <a href="yaml/changelog-vetproof.html"><img border="0" src="yaml/changelog.jpg" alt="Change log" />.

Falls Sie Hilfe benötigen oder Fragen haben, können Sie sich gern an <a href="mailto:[email protected]?subject=VetProof REST-Gateway&body=Hallo qualitype-Team,%0Dwir haben folgende Anfrage zum REST-Gateway%0D%0D%0DIhre Signatur%0D_____________________________________________________________________________________________________%0DHinweis - folgende Informationen sind bei Support-Anfragen oftmals hilfreich%0D- Request, Reply (Reply beinhaltet einen Supporttoken, Requestdaten kann man anonymisieren)%0D- URL, Zeitpunkt, Gatewaykennung “id”, Benutzername “alias”, wenn nicht im Reply enthalten%0D- Screenshot">[email protected] wenden.

This SDK is automatically generated by the OpenAPI Generator project:

API version: leo1.0
Package version: leo1.0
Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://qualitype.de

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 vet_proof_external_tools_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 vet_proof_external_tools_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 VetProofExternalToolsApi = require('vet_proof_external_tools_api');


var api = new VetProofExternalToolsApi.AuthenticationApi()
var opts = {
  'accessTokenInput': new VetProofExternalToolsApi.AccessTokenInput() // {AccessTokenInput} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accessTokenPost(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://test.vetproof.de/user-rest

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- VetProofExternalToolsApi.AuthenticationApi | accessTokenPost | POST /access-token | Token zur Authorisierung weiterer Anfragen VetProofExternalToolsApi.EchoApi | echoPost | POST /echo | Prüfung der unterstützten Datentypen VetProofExternalToolsApi.EinstalldatenApi | herdsGet | GET /herds | Einstalldaten eines Tierhalters abfragen VetProofExternalToolsApi.EinstalldatenApi | herdsIdDelete | DELETE /herds/{id} | Einstalldaten löschen VetProofExternalToolsApi.EinstalldatenApi | herdsIdGet | GET /herds/{id} | Einzelne Einstalldaten abfragen VetProofExternalToolsApi.EinstalldatenApi | herdsIdPut | PUT /herds/{id} | Einstalldaten bearbeiten VetProofExternalToolsApi.EinstalldatenApi | herdsPost | POST /herds | Einstalldaten anlegen VetProofExternalToolsApi.FreigeschalteteTierhalterApi | farmerLinkGet | GET /farmer-link | Freigeschaltete Tierhalter abfragen VetProofExternalToolsApi.NullmeldungFrHalbjahrApi | periodVoidReportGet | GET /period-void-report | Nullmeldung je Halbjahr abfragen VetProofExternalToolsApi.NullmeldungFrHalbjahrApi | periodVoidReportPost | POST /period-void-report | Nullmeldung je Halbjahr anlegen VetProofExternalToolsApi.NullmeldungFrHerdenApi | herdVoidReportGet | GET /herd-void-report | Nullmeldung für Herde abfragen VetProofExternalToolsApi.NullmeldungFrHerdenApi | herdVoidReportPost | POST /herd-void-report | Nullmeldung für Herde anlegen VetProofExternalToolsApi.PingApi | pingGet | GET /ping | Testanfrage VetProofExternalToolsApi.PingApi | unsecuredPingGet | GET /unsecured/ping | Testanfrage VetProofExternalToolsApi.ProduktionsdatenFrTierarztBelegeApi | stableDataGet | GET /stable-data | Produktionsdaten für Tierarzt-Belege abfragen VetProofExternalToolsApi.ProduktionsstttenApi | stablesGet | GET /stables | Produktionsstätten eines Tierhalters abfragen VetProofExternalToolsApi.ProduktionsstttenApi | stablesIdDelete | DELETE /stables/{id} | Einzelne Produktionsstätte löschen VetProofExternalToolsApi.ProduktionsstttenApi | stablesIdGet | GET /stables/{id} | Einzelne Produktionsstätte abfragen VetProofExternalToolsApi.ProduktionsstttenApi | stablesIdPut | PUT /stables/{id} | Produktionsstätte bearbeiten VetProofExternalToolsApi.ProduktionsstttenApi | stablesPost | POST /stables | Produktionsstätte anlegen VetProofExternalToolsApi.TherapieIndexApi | therapyIndexByFarmerGet | GET /therapy-index-by-farmer | Therapie-Index je Tierhalter für einen Tierhalter abfragen VetProofExternalToolsApi.TherapieIndexApi | therapyIndexByHerdGet | GET /therapy-index-by-herd | Therapie-Index je Herde für einen Tierhalter abfragen VetProofExternalToolsApi.TierarztBelegRcknahmenApi | veterinaryDocumentsIdReturnsDelete | DELETE /veterinary-documents/{id}/returns | Tierarzt-Beleg-Rücknahme löschen VetProofExternalToolsApi.TierarztBelegRcknahmenApi | veterinaryDocumentsIdReturnsGet | GET /veterinary-documents/{id}/returns | Einzelne Tierarzt-Beleg-Rücknahme abfragen VetProofExternalToolsApi.TierarztBelegRcknahmenApi | veterinaryDocumentsIdReturnsPost | POST /veterinary-documents/{id}/returns | Tierarzt-Beleg-Rücknahmen abgeben VetProofExternalToolsApi.TierarztBelegRcknahmenApi | veterinaryDocumentsReturnsGet | GET /veterinary-documents/returns | Tierarzt-Beleg-Rücknahmen abfragen VetProofExternalToolsApi.TierarztBelegeApi | veterinaryDocumentsGet | GET /veterinary-documents | Tierarzt-Belege abfragen VetProofExternalToolsApi.TierarztBelegeApi | veterinaryDocumentsIdDelete | DELETE /veterinary-documents/{id} | Tierarzt-Belegzeile löschen VetProofExternalToolsApi.TierarztBelegeApi | veterinaryDocumentsIdGet | GET /veterinary-documents/{id} | Einzelnen Tierarzt-Beleg abfragen VetProofExternalToolsApi.TierarztBelegeApi | veterinaryDocumentsPost | POST /veterinary-documents | Tierarzt-Belege abgeben VetProofExternalToolsApi.TierarztIDApi | veterinaryIdGet | GET /veterinary-id | VetProof ID des Tierarztes abfragen VetProofExternalToolsApi.TierhalterApi | farmersChangesGet | GET /farmers/changes | Tierhalter abfragen, für die Änderungen vorliegen VetProofExternalToolsApi.TierpltzeApi | herdSizeGet | GET /herd-size | Tierplätze für Schweine- und Rinderhalter abfragen VetProofExternalToolsApi.TierpltzeApi | herdSizePost | POST /herd-size | Tierplätze für Schweine- und Rinderhalter übermitteln VetProofExternalToolsApi.VerknpfungVonTierhalterUndTierarztApi | farmerVeterinaryLinkDeletePost | POST /farmer-veterinary-link/delete | Verknüpfung von Tierhalter und Tierarzt löschen VetProofExternalToolsApi.VerknpfungVonTierhalterUndTierarztApi | farmerVeterinaryLinkPost | POST /farmer-veterinary-link | Verknüpfung von Tierhalter und Tierarzt anlegen VetProofExternalToolsApi.VersionApi | versionGet | GET /version | Version des Systems

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

vet_proof_external_tools_api

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

vetproofGatewayToken