Get form help or validate form data

Use this endpoint to retrieve help information for form fields. You can also use it to perform server-side validation of form data.

Request

To get help information or validate form data, send a POST request to the endpoint below. The query parameters control the behavior of the endpoint.

URL: /task/help

Method: POST

Authorization: required

POST /ibis/rest/task/help?ajaxType=validation&ajaxMode=Submission&workflowName=@@@ISAjaxCall@@@&params=webform@@@ServerSideValWAC/form_webappvalidateserversidetg(2)_serversidevalidationwebapp@@@210004.xml@@@validation@@@ajaxSubmission@@@null@@@en HTTP/1.1
Accept: application/xml
Host: localhost:8080

Query Parameters

The following table lists the query parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`ajaxMode`	Defines the mode of the AJAX request.	yes	`Submission`: Triggers a server-side validation.
`ajaxType`	Defines the type of the AJAX request.	yes	`validation`: Specifies that a validation should be performed.
`workflowName`	Specifies the technical name of the workflow as visible in the Queue Manager.	yes	A valid URL-encoded string.
`params`	Provides context for the server-side operation, including form name and language.	yes	A structured, alphanumeric string.

ajaxMode

Defines the mode of the AJAX request.

yes

Submission: Triggers a server-side validation.

ajaxType

Defines the type of the AJAX request.

yes

validation: Specifies that a validation should be performed.

workflowName

Specifies the technical name of the workflow as visible in the Queue Manager.

yes

A valid URL-encoded string.

params

Provides context for the server-side operation, including form name and language.

yes

A structured, alphanumeric string.

Request Body

The body of the request contains the form data to be validated.

submitId=&hiddenSubmitIS=_nothing&TextField_114030349=&%23sb_value=Next

Response

The response contains the validation result or the help text information.

HTTP/1.1 200 OK
Content-Type: application/xml

<result>
    <header>
        <heading>3 errors at form validation.</heading>
        <headingUnsigned>{errorCount} error{s} at form validation.</headingUnsigned>
        <language>en</language>
    </header>
    <html>Field 1 is mandatory<errornodes id="1"><errornode>Field1WAC</errornode></errornodes>
    </html>
    <html>Field 2 is mandatory<errornodes id="2"><errornode>Field2WAC</errornode></errornodes>
    </html>
    <html>Field 3 is mandatory<errornodes id="3"><errornode>Field3WAC</errornode></errornodes>
    </html>
</result>

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.