When creating a webservice endpoint, there are a lot of things to keep track of! To make a working endpoint all puzzle pieces have to be in the right place. In this article, we’ll show you all the different settings the webservice endpoints have to offer.
Webservice Endpoint Overview
Close: By clicking on this button the select section will be closed.
New: By clicking on this button the Add new form will appear on the right side of the screen.
Question mark [
? ]: By clicking this button, a new panel pops-up. This panel will present an instruction video on HowTo create and customize Forms?
Searchbar: The searchbar enables you to easily find your webservice endpoints. You can narrow down the results by searching on the name of the endpoint.
Row: Every row represents an endpoint of your webservice, by clicking on the row more information about the endpoint will be shown.
Refresh: By clicking Refresh or pressing
R on your keyboard, your data will be updated, if recently altered.
Webservice Endpoint Form
Close: By clicking on this button the form will be closed.
Changes: When clicking on the changes icon next to the
Run test button a new tab will slide down, in this tab it is possible to see all changes made to the webservice.
Run Test: By clicking on this button the test tab will slide down. This button is not clickable when creating a new endpoint.
Save: By clicking this button the endpoint will be saved.
These options make up the basic settings of the webservice endpoint.
Name: Here you can enter a name for the webservice endpoint.
Http method: The HTTP method defines in which way you want your endpoint to respond to the webservice. More information about HTTP methods can be found here: What are HTTP methods on web pages?
Path: With the path field it is possible to set a pathname addition to your webpages. If you would change the path name, the path of the pages you created within the group will automatically change to the new path name. By clicking on the “Insert variable” button it is possible to use variables in your pathname.
The following option defines what kind of request we're performing.
Request Content-Type: Choose in which format type you send the request to your host, this also depends on what type of format your host expects to receive. You can choose between 4 options:
- [inherit]: When choosing the inherit option the endpoint will inherit the Request Content-Type of the webservice the endpoint is for.
- JSON: This option will send the request configured as JSON.
- Multi-Part: This option will send the request as Multi-Part type. You should only use this type of request when your host accepts this content type, and you want to send a file without further body values.
- Other: You can choose this option when your host requires any other type of request content type than listed above.
These options define what kind of response we're receiving and how we're handling it.
Response Content-Type: Enter in which format type the host will send its response, this depends on your host. There are 4 options that you can choose from:
- [inherit]: When choosing the inherit option the endpoint will inherit the Response Content-Type of the webservice the endpoint is for.
- JSON: It is very easy to set up a webservice with a JSON response, it is possible to quickly translate this data to your application with our awesome custom models.
- XML: With XML it is possible to translate data by setting up a text expression or an endpoint template. If you want to know how to set up an XML webservice this article could help you out: HowTo setup a XML webservice
- Other: When expecting any other type of response than JSON or XML then you should choose this option.
Custom model: Here you can select a custom model that your endpoint can use for storing data. When using JSON Request and Response types it is also possible to generate custom models for your data. More about custom models and generating them can be found here: What are custom models?
Response returns: These radio buttons indicate how the custom models should be used. They are only visible when a custom model has been selected. When generating a custom model this option will be set automatically. There are 2 options you can pick from:
- A single custom model: With this option selected, a single custom model will be used to store the data of the webservice call.
- A collection of custom models: When selecting this option instead of one custom model, a collection of custom models will be created to store your date.
Response code: Here you can set up which response codes the webservice will accept as successful. You can set a single response code, but also a range of response codes by using trailing dots. By default, the value is
2.. which means that all response codes in the
200 range will be accepted.
Variables and Payload
The following options make up the actual message we're including in our request and the variables to add dynamic values to our request.
Variables: There are many variables that you can add to your webservice endpoint, but it is important to add them as the correct type. Within webservice endpoints, there are 4 different types of variables:
- Header variables: With Header variables, you can add dynamic values in the request headers specific for the endpoint.
- Query variables: With Query variables, you can add dynamic values that are automatically appended (in alphabetical order) to the Path setting. For example, Query variables called
age, results in the following outcome:
- Path variables: With Path variables, you can add dynamic values to the Path setting. You'll have to add them manually though, by selecting them through the variable browser.
- Body variables: With Body variables, you can include variables as you're request's content. These variables are automatically parsed in JSON format in the request's body, so make sure to set
JSONas the Request Content-Type.
The variables that you create will become visible in the variable table of that variable type. In there you can create, edit and remove your variables.
Template: Here you can add a template for the body of your data. You can choose an existing template or create a new one by choosing
- New -. It is not advised to use a template when already using body variables.
Custom model: By clicking on the Custom model button on the right side of the form the custom model tab will open. Here, you can see and edit the custom model the webservice endpoint is assigned to.
Value: In the value field you can change the value of the variable. By clicking on the button on the right of the field the Variables browser will pop up, in there you can add a variable to use as value.
Gear: By clicking on the gear icon, the Edit variable modal will pop up.
Add: By clicking on this button the New variable modal will pop up.
Name: Here you can add the name for the variable.
Is input variable: With this option, you can make your variable an input variable. When doing this it will no longer be possible to change the value of the variable in the value column. You can give the variable a value inside of an action HTTP request.
Required: With this option, you can make the variable required. This means that it is necessary to give the variable a value. This option becomes visible when the Is input variable option is checked.
After saving the webservice endpoint with all the values set in the right settings, it's time to take it for a test-drive. Click the green Run test to see the magic happen.
Close: By clicking on this button the form will be closed. Note that this doesn’t just close the test but the whole endpoint view.
Generate custom model: When using a JSON response it is possible to generate a custom model based on the testing data. The custom model will be automatically linked to the webservice endpoint.
Close test: By clicking on the Close test button the test will be stopped and the endpoint form will be visible again.
Edit: The Edit button cannot be used while in the test tab.
Request url: Here you can see the full URL that is used for the webservice request.
Request headers: By clicking on the Show button all the request headers used for the webservice call will be shown.
Response code: Here the response code that the endpoint returns with will be shown, when this response code is in the range of the set response code of the endpoint the call will be seen as successful.
Response headers: By clicking on the Show button all the response headers used for the webservice call will be shown.
Response body: In here the fetched data will be shown, by clicking on the Fullscreen button it is possible to see the data in fullscreen.
Cancel: By clicking on the Cancel button the test will be stopped and the endpoint form will be visible again.