form_set_answer ()

Input

parameters:

• session: is the session id obtained in the session_init call
• form_id: is the ID of the form obtained by the URL or by the call form_list()
• question_id: is the ref of a question in a form. The ID can be obtained by the function form_get_summary()
• value:doesn’t apply for CHECK, RADIO and COMBO question types. Value to store as answer of the question. Beware of the following special case
  • From API Version 2.7.10, when value = NULL, the previous value is not changed. If you want to reset the question, then you should pass an empty string. In previous API versions, the value NULL was considered the same than an empty string
• option_id: is a valid number for the slected options in CHECK, RADIO and COMBO question types. If the field is a CHECK (multiple answers possible) the selected options are split by ‘|’.
• event_id: if the form is a template of an event, the event ID reference is needed. In the result, the new form_id is returned.
• form_close: (default = true) close the FORM automatically if completed (is the last question and all mandatory questions are answered)

Output

parameters:

• result: contains an Xml with the following information:
  • form_completed: indicates whether the FORM is complete after saving the answer of the question. If the FORM is complete, it is safe to invoke form_close()
  • action_request: A JSON formatted string that suggests an action to the client (e.g. display a TASK or EVENT). This node will only be included when the FORM is closed as a consequence of the invocation to form_set_answer() and the FORM contains an ACTION FORMULA CLIENT_REQUEST () that generates an action request string. It is a choice of the client whether to consider executing the suggested action or not. Introduced in API Version 2.7.16
  • review: Information to review
    • first_question: a reference to the first editable question of the reviewed FORM: It can be used by the client to display the first question if the user wants to make modifications
    • questions: Contains the same information that would be obtained by calling form_get_summary() on a closed FORM. The purpose of this information is to allow the client to show a summary of the FORM without calling form_get_summary.
      NOTE: This node will only be returned when:
      • The FORM has been completed. See below comments about the behavior in embedded FORMs (FORM ITEMs)
      • The FORM TEMPLATE used to create this FORM has the property 'REVIEW' = true
• refresh: Y/N. If the value is “Y” then the function form_get_summary must be called
• next: The next question that needs to be answered. There is a special case when a previous question in the FORM is empty and is also mandatory. In this case that question will be returned as 'next question'
• next_form: Reference to the FORM where the "next" question is located
• next_task: Reference to the TASK where the "next" question is located
• next_strict: The next visible question (no matter if it needs to be answered or not, nor whether is editable or not)
• next_strict_form: Reference to the FORM where the "next_strict" question is located
• next_strict_task: Reference to the TASK where the "next_strict" question is located
• ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced
• ErrorCode: The error code associated to the message returned in ErrroMsg (only if an error happens)

Request

sample:

form_set_answer ( “LCAAAAAAAA”, 1234, 76665, “No”);

Response

sample:

Notes: