Welcome to Paradise

Web Services

Paradise allows you to use web services as a data source in your screens. You can use SOAP or REST Web Services.

Important: Your web service must respect a specific contract in both input parameters and output data.

Input Parameters

For both SOAP and REST services the parameters received by the service must be scalar values.

Service Output Result

SOAP: It should return an XML with the following structure. The names of the nodes are of example.

 
    <Rows>
    <Row>
    <Col1>...</Col1>
    <Col2>...</Col2>
    <Col3>...</Col3>
    </Row>
    <Row>
    <Col1>...</Col1>
    <Col2>...</Col2>
    <Col3>...</Col3>
    </Row>
    </Rows>

REST. Must return a simple JSON array of objects, for example:

 
    [
    {col1:'...', col2:'...', col3:'...'},
    {col1:'...', col2:'...', col3:'...'}
    ]

To start using a web service in your application the first thing to do is to add the URL of the service in the tab "Projects", "Web Services" and then click on "Create New Connection".

If your service is SOAP the url should be the path to the service. Eg.: Http://www.servidor.com/webservice/service.asmx

If it is REST, this url can be the root of the WS only, then in the WebService Data Source configuration you can specify the method to execute.

For example, say your application will use two services: http://server/services/api/clients_get and http://server/services/api/products_get. You could set url "http://server/services/api/" on the connection value, and then setup the clients_get Method Name on the Web Service Data Source configuration:

Once finished, click "Create".

Note: this service should be accessible from the Paradise server.

After the connection is created we can use it on our screens. To add a data source to the screen drag a component of type "Web Service Data Source" to your screen:

This will add the component below the footer of your application. Click the web service and then click the "Configure" in the panel "Control (DataSource)" to open the configuration screen.

This is where you specify the service method to execute.

SOAP:

Url Source: If you select "DataBase" you may use the previously created url. If you select "Raw Url" you should write the url of the service.

Url: Here you select or type the url of the service.

Service Name: If you're using an .Net ASMX Service, you have to specify here the name of the service class. Because these services are consumed from a NET client, you can only use SOAP services that may be created as .NET clients.

Method Name: Name of the function to call.

Once you have completed this configuration you must click the "Parameters" button. This action will cause the Paradise server to try to connect to the specified web service and create a client of it. If there was no error it will create a table with the parameters of the service.

Then, you must assign a default value to the parameters and click on "Preview". This action runs the web service and gets its result schema, allowing binding it to the controls on the screen.

REST

Url Source: If "DataBase" is selected you may use the previously created service url. If you select "Raw Url" should write the url on the textbox below.

Url: Here you select or type the url of the service.

Method Name: Name of the method to call (may be empty if the request is made directly to the specified URL on "Url Source").

Method Action: Indicates whether the job should be done through a GET, a POST, a PUT or DELETE.

Username y Password: If the service requires basic authentication here you can specify the user and password.

Because with REST the parameters cannot be discovered, you must add them manually by clicking on the "Parameters" button.

For example, if your REST service is called using a GET as follows: http://..../clientsByName?name=juan&surname=perez should add the "name" and "surname" parameters.

You can link these parameters to controls the same screen or in previous screens. To learn how to configure a mapping, see "How to bind controls to data sources?" in the FAQ.

Once set up you must click "Preview" to run the service and get the result structure to bind it to the controls on the screen.

Community

Made With