Module: WebService

Express router providing web service related routes

Requires

  • module:express
  • module:path
  • module:js-base64
  • module:CrmConnector
  • module:CrmExecutions
  • module:CrmObject

Members

(inner, constant) app

initialized express object

(inner, constant) Base64

Base64 module

(inner, constant) CrmConnector

Reference to CrmConnector

(inner, constant) CrmExec

Reference to CrmExecutions

(inner, constant) CrmObj

Reference to CrmObject

(inner, constant) express

express module

(inner, constant) path

path module

Methods

(static) /*(*, middleware)

Default route. If no route match is found this route will route automatically to the documentation route.
Parameters:
Name Type Description
* string not implemented routes - Express path
middleware callback Express middleware (standard: req, res)

(static) /:base64(base64encode, middleware)

Main route for the web service process. This Method is responsible for decoding the incoming Base64 String. If all needed params in relation to the specif action are provided the method will redirect to the corresponding web page.
Parameters:
Name Type Description
base64encode string Express path
middleware callback Express middleware (standard: req, res)

(static) get/doc(docPath, middleware)

This route is responible for rendering the documentation
Parameters:
Name Type Description
docPath string Express path
middleware callback Express middleware (standard: req, res)