Porty serwera
To establish a WebService connection to RFEM and RSTAB, specific server ports need to be accessed. The range of available server ports can be modified within the program settings by navigating to Options → Program Options:
By default, the server port range is set from 8081 to 8089. The lowest port value in the program settings corresponds to the port specified in the WSDL URL for accessing RfemApplication, which in this guide will be 8081.
Boomerang Guide
Boomerang is a user-friendly API testing tool designed for API debugging. In order to access it you first need to install the Boomerang Browser Plugin.
1. Accessing RfemApplication Classes
To access the available classes in RfemApplication, follow these steps:
- Use the following WSDL URL: http://localhost:8081/wsdl
- Load the URL and add it to service.
The port which you have to use in the WSDL URL may be different in your case. Try one of the other ports if 8081 doesn't work.
Once completed, the RfemApplication service will be accessible under the service tab, displaying all associated classes. These classes encompass everything related to the RFEM application itself.
2. Obtaining URL of Active Model
To retrieve the URL of your model with the correct server port, execute the following steps:
- Run the "get_active_model" function by double-clicking it in the left menu.
- Click the send button.
Boomerang will automatically navigate to the response tab, where the URL of the model will be displayed. In this example the server port of the current model is 8083.
3. Accessing RfemModel Classes
To access all available classes in RfemModel, execute the following steps:
- Click on “Add Service” on the left.
- Use the following WSDL URL: http://localhost:8083/wsdl
- Load the URL and add it to the services.
Upon completion, the RfemModel service will be accessible under the service tab, displaying all associated classes. These classes encompass all the model data, including basic objects, loads and more.
4. Verifying WebService Operations
You can now test all operations by double-clicking on them in the service menu on the left. Some operations require passing parameters in the request tab, while others can be executed simply by clicking “Send”. This tutorial will demonstrate the testing of certain operations.
get_all_selected_objects()
To test this operation no parameters need to be passed. You can directly send the request after selecting some objects in RFEM.
The operation returns a list of object_location objects which consist of object type and object number:
get_member()
In order to test the get_member function you need to provide the number of the desired member:
The response of this operation provides all properties of member number 1:
SoapUI Guide
SoapUI is a powerful open-source application designed for testing SOAP and REST protocols. The desktop application can be downloaded under .
1. Creating a new SOAP project
To get started, open SoapUI and create a new SOAP project:
Customize the project name as desired and utilize http://localhost:8081/wsdl as initial WSDL. As described in the Boomerang guide, the port may be different in your case. Try one of the other ports if 8081 doesn't work. Once loaded, the navigator on the left will display all the classes associated with RfemApplication.
To acquire the initial WSDL for RfemModel, execute the get_active_model operation by double-clicking on “Request 1”. Prior to running the operation, ensure that a model is opened in RFEM or RSTAB. Initiate the operation by clicking on the green triangle and shortly afterward the response containing the current server port will be displayed:
Now you can add a new WSDL to the project using the server port 8083 via Project → Add WSDL:
Subsequently all classes of RfemModel will appear in the navigator as well.
2. Verifying WebService Operations
All WebService operations can now be tested by double-clicking on “Request 1” under the respective class. For certain operations, parameters need to be provided on the left side. However, for other operations no parameters are required and you can simply click „Send“. This tutorial will show the testing of some operations.
get_all_selected_objects()
To test this operation, no parameters need to be passed. After selecting objects in RFEM, you can directly send the request and view the response.
On the right side of SoapUI the function returns a list of type object_location that consists of object type and object number:
get_member()
In order to test the get_member function you need to input the number of the desired member:
The response of this operation provides all properties of member number 1:
Uwagi końcowe
Both Boomerang and SoapUI are valuable tools for visualizing and testing the available operations within our Webservice library. They facilitate efficient API testing and debugging.