On January 2021 we released the version 2.3 of the FormBuilder API. This new version includes performance improvements and a better respect of HTTP protocol for RestFull APIs. All v2.0 URIs of the FormBuilder API are available in v2.3. If you are currently using the v2.0 of the FormBuilder API, we encourage you to update to the newer version. The new documentation is available here here.
| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the result. |
result |
string |
Results of the result. Max length: 65535. |
form |
string |
Id of the result's form. Max length: 16. |
ipAddress |
string |
IP address of the client. Max length: 45. |
client |
string |
Id of the client (if exist in database, otherwise 0). Max length: 16. |
date |
string |
Date of the result. |
Deletes an entry on the form's result list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}/results/{resultId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
resultId |
string |
Result identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the form's result list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}/results/{resultId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
resultId |
string |
Result identifier. |
Do not supply a request body with this method.
If successful, this method returns a Result resource in the response body.
Returns entries on the form's result list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}/results| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Adds an entry to the form's result list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}/results| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
In the request body, supply a Result Resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
form |
string |
Id of the result's form. |
| Optional Properties | ||
id |
string |
Identifier of the result. |
author |
string |
Author of the result's form. |
result |
string |
Results of the result. |
form |
string |
Id of the result's form. |
ipAddress |
string |
IP address of the client. |
client |
string |
Id of the client (if exist in database, otherwise 0). |
date |
string |
Date of the result. |
If successful, this method returns a Result resource in the response body.
Updates an entry on the form's result list.
Authentication is required to execute this request. Please refer to Authentication for more.
{formId}/results/{resultId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
formId |
string |
Form identifier. |
resultId |
string |
Result identifier. |
In the request body, supply a Form resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
form |
string |
Id of the result's form. |
If successful, this method returns a Form resource in the response body.
Watch for form filled.
Authentication is required to execute this request. Please refer to Authentication for more.
The watch send an Result resource in the request body
{formId}/results/watch| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the watch. Read-only. |
address |
string |
The address where notifications are delivered for this watch. |
If successful, this method returns an of Watch resource in the response body.