How do I configure Web Service Reference Plugins?

Created by Mark Eves, Modified on Wed, 15 May at 9:28 AM by Ben Hayes

 

Pre-requisites

 

A Web Service Reference Plugin allows an organisation to reference, query, and return results into a Form using a specific web service. A User will enter the input values as part of completing the Form, and the web service will return the defined output values.

 

An organisation can define both Input and Output values, which are visible to the User. More than one Web Service Reference can be used within a Form, and HTTP Output parameters can be used to provide HTTP Input values in other Plugins to further enhance the functionality.

 

There are specific requirements on the Web Service Reference Plugins:



  • We support REST web services using .xml or .json output format.
  • We support GET and POST method parameters.
  • The URL must include Query Parameters for the relevant input values.
  • An XPath must be specified for the positioning of any data elements within the .xml output. For .json output a json path to output parameters.
  • Returned results can be used to populate Hidden Items, Text Fields, and Select Lists. To populate a Select List value, any results must be returned within <option> tags.
  • This is to be used for browser-based Forms only, and we do not support this functionality on our native Mobile app platform.

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article