Simple-vertec-api NPM

Simple Vertec Api

Simple Vertec Api is an simple wrapper around www.vertec.com XML webservice for node.js. It features solid CRUD support for dealing with Vertec's data.

Documentation

Delimination and Responsibility

This XML wrapper will only give you a simpler way of making requests via Vertec's own XML interface. There won't be any validations done for data input (you have to do it yourself or rely on Vertec's validation as it is their responsibility on server side).

Version 3 offers additional query options for further transforming response data, included caching support, parallel request mode and many more. Take a look at the documentation.

Version 4 supports Vertec's new token based authorization.

Installation

Run this command:

$ npm install simple-vertec-api --save

Example for a simple query request

var SimpleVertecApi = require('simple-vertec-api').SimpleVertecApi;
var SimpleVertecQuery = require('simple-vertec-api').SimpleVertecQuery;

var api = new SimpleVertecApi('http://localhost', 'my-username', 'my-password', true);
SimpleVertecQuery.setApi(api);

new SimpleVertecQuery()
    .whereOcl('Projektbearbeiter')
    .whereSql('aktiv = 1')
    .orderBy('name')
    .addFields('name', 'kuerzel')
    .get()
    .then(function(response) {
        // do something with the result
        console.log(response);
    });

Example for a raw api request

var SimpleVertecApi = require('simple-vertec-api').SimpleVertecApi;
var api = new SimpleVertecApi('http://localhost', 'my-username', 'my-password', true);

// searches for some records starting from day X
var select = {
	ocl: 'Leistung',
	sqlwhere: "(text like '%?%') and (CreationDateTime >= {ts '? 00:00:00'})",
	sqlorder: 'datum'
};
var params = [
    'search text',
    '2015-08-22'
];
var fields = [
    'minutenInt',
    'minutenExt',
    'datum',
    'text'
];
api.select(select, params, fields).then(function(response) {
    // do something with the result
    console.log(response);
});