Include the atg-rest-return-form-handler-exceptions
control parameter with a Legacy REST Web Services request to return form handler exceptions in the HTTP response from the server. Set the value of the control parameter to true
.
The following example shows the response to a Legacy REST Web Services request to invoke /atg/userprofiling/InternalProfileFormHandler/login
. The response includes an exceptions
element that contains information about the exception that occurred.
<atgResponse> <class>class atg.rest.processor.BeanProcessor$FormHandlerExceptions</class> <exceptions> <formExceptions> <element>Missing value for the login property</element> </formExceptions> </exceptions> <result>true</result> </atgResponse>
The following example shows the response to a successful Legacy REST Web Services request to invoke /atg/userprofiling/InternalProfileFormHandler/login.
The response includes an empty exceptions
element because no exceptions occurred.
<atgResponse> <class>class atg.rest.processor.BeanProcessor$FormHandlerExceptions</class> <exceptions/> <result>true</result> </atgResponse>
Note: if you choose to include both exceptions and form handler properties in a Legacy REST Web Services request, the class element in the atgResponse
will contain the following value: class atg.rest.processor.BeanProcessor$FormHandlerPropertiesAndExceptions
. See Returning Legacy REST Form Handler Properties.