bigregister-soap v1.0.7

BIG Register SOAP wrapper

A node wrapper for the SOAP webservice on http://webservices.cibg.nl/Ribiz

Install

npm install bigregister-soap --save

Usage

With promises

// import package
const bigRegister = require('bigregister-soap')

// connect to SOAP server
bigRegister.connect()

	// find user data by BIG-number
	.then(() => bigRegister.findByRegistrationNumber('xxx'))
	.then((data) => {
        // do something with data...
	})

	// catch errors
	.catch((err) => {
        // an error occurred
	})

Using async / await and ES6 imports

// import package
import bigRegister from 'bigregister-soap'

const example = async() => {
    try {

    	// connect to SOAP server
    	await bigRegister.connect()

    	// find user data by BIG-number
        const data = await bigRegisterApi.findByRegistrationNumber('xxx')

        // do something with data

    } catch(err) {

        // an error occurred

    }
}

Documentation

• Connect to SOAP server:

  	Method structure _(pseudo code)_:<br />
  	`BigRegister.connect(wsdl:String):Promise.<void>`
  
  	> @note: it's not necessary to wait for resolving the promise, since each API method waits for this promise to be resolved.
  
  	```javascript
  	const BigRegister = require('bigregister-soap')
  
  	BigRegister.connect()
  		.then(() => console.log('connected'))
  
  		.catch((err) => console.error(`An error occurred: ${err}`))
  	```

• Find user by BIG-number:

  	Method structure _(pseudo code)_:<br />
  	`BigRegister.findByRegistrationNumber(bigNumber:String|Number): Promise.<Object>`
  
  	```javascript
  	const BigRegister = require('bigregister-soap')
  
  	BigRegister.connect()
  		.then(() => BigRegister.findByRegistrationNumber('xxx'))
  		.then((data) => console.log(data))
  
  		.catch((err) => console.error(`An error occurred: ${err}`))
  	```