Function prototype	form_get_question ( session, form_id, question_id )
API Version	All

Returns all information about a question

Input

parameters:

session: is the session id obtained in the session_init call
form_id: a form reference obtained by the URL or by the call ¡Error! No se encuentra el origen de la referencia. or event_form_list ( session, event_id )
question_id: is the ID of a question in a form {form_id/}question_id. The ID can be obtained by the function form_get_summary()

Output

parameters:

question: is a question XML like:

result: XML with the information about the question:
- form: properties of the question's parent FORM
  - ref: is the parent form reference
  - nav_mode: Navigation mode. Suggestion about how to present the questions of the FORM. See NAVIGATION_MODE property of ITEM TEMPLATE OBJECT. Introduced in API version 2.7.21
- question_id: is the referenc of the question for the form with the format {form_id/}question_id. It may include a “label” of the original form is the form is a merged one
- item_code: ITEM CODE of the question
- question_template_id: ID of the ITEM TEMPLATE OBJECT. Introduced in API version 2.7.15
- order: determines the position of the question into the FORM. If a question belongs to an array, then all question of the same array have the same "order" value
- is_section_title: (true/false) Only in STATIC_TEXT ITEMs. If true, the description of this ITEM should be considered as the title of as section. All the ITEMS following this one into the FORM will be considered as part of the same section (until another ITEM marked as section title appears)
- section_title: This property has value in the following situations:
  - When the question is placed after a STATIC_TEXT marked as 'section_title' (i.e. is_section_title = true). The value will be the description of the closest section title ITEM.
  - When the question belongs to an embedded FORM. Embedded FORMs are represented by a special ITEM of type "FORM" which is included in the FORM referenced by the parameter form. The value of section_title will be the description of the ITEM of type "FORM"
- array_ref: Only for ARRAYS. Indicates the reference of the ARRAY to which question belongs. This value is the reference of the ITEM of type "ARRAY" that contains the question. Introduced in API version 2.7.24
- row: only for ARRAYS. Determines the row to into an ARRAY to which this question belongs
- column: only for ARRAYS. Determines the column to into an ARRAY to which this question belongs
- empty_row: (0 / 1) Only in ARRAYS. indicates whether the question belongs to an empty row of the ARRAY
- inner_questions: Only in questions of type "FORM" with property nav_mode = 1. Contains a list of the questions in the embedded FORM. See EMBEDDED FORMS section below
  - question: information about the question in the embedded FORM
    - ref: reference of the question
    - description: Description of the question
- description: is the text of the question in the session language
- description_closed: Is the text of the question as it is displayed when presenting the summary of the FORM
- mandatory: Y for yes N for no
- tabulation: is the tabulation of the question
- exclusive: if the answer is NO the form is a “reject” form
- min_length: (only if it has a value) the minimum character length admitted
- max_length: (only if it has a value) the maximum character length admitted
- num_dec: number of decimals accepted
- min_value: (only if the question type is NUMERICAL). Minimum value accepted for the answer of the question
- max_value: (only if the question type is NUMERICAL). Maximum value accepted for the answer of the question
- increment (only when question type is VAS): defines the minimum increment that can be applied to the value
- device_type: when the 'type' of the question is DEVICE, then it is also included the 'device_type' indicating the DEVICE TYPE CODE.
- tip: is a tip for a question, shown in gray color (optional tag)
- value: is the answer of the user. In the multiple-select values question type, the values can be separated by a pipe character (|)
- value_description: is the description of the selected value in a RADIO, SELECT, ARRAY,.. In the multiple-select values question type, the values can be separated by a pipe character (|)
- default_value: indicates the default value that will be assigned to the question if no answer is provided. Introduced in API Version 2.7.26
- formula: The formula assigned to the question. This property is only included if a FORM FORMULAS has been assigned to the question and the role of the active SESSION is "SERVICE". Introduced in API version 2.7.26
- error_msg: Error message (if any) that occurred when an invalid value has been tried to be assigned to this question (e.g. as a result of the calculation of a FORMULA that generates an error). This property is only included when the role of the active SESSION is "SERVICE". Introduced in API version 2.7.29
- type: is the type of the question, can be NUMERICAL, BOOLEAN, TEXT, TEXT_AREA, STATIC_TEXT, SELECT, DATE, FORMULA, HORIZONTAL_CHECK, VERTICAL_CHECK, VERTICAL_RADIO, DROP_DOWN, HORIZONTAL_RADIO, ARRAY_CHECK, CODE, FILE, DEVICE
- †group: if the following “N” questions shall be collapsed and expanded
- literal_format: a JSON expression that defines how the text of the question should be presented (see LITERAL_FORMAT PROPERTY)
- value_format: a JSON expression that defines how the value of the ITEM should be rendered in the UI (see VALUE_FORMAT PROPERTY)
- arrangement: a JSON expression that defines how the value of the ITEM should be presented in the UI (see ARRANGEMENT PROPERTY)
- constraints: a JSON expression that defines the constraints that are applied to the value of the ITEM (see CONSTRAINT PROPERTY)
- barcode_scan: Indicates whether the value of this question is allowed to be entered by scanning a barcode (see BARCODE_SCAN PROPERTY). Introduced in API version 2.7.15
- progress: (0-100) Value of progress in the FORM. This value is a percentage that reflects the relative position of the question respect to the total of questions.
- multimedia_info: only in MULTIMEDIA questions. Returns the information of the LIBRARY RESOURCE OBJECT that contains the multimedia resource associated to the question (audio or video)
- image_list: Contains a list of images that will be used to display the question instead of the question description (or along with it). This node will only be included when the question type is one of the following: BOOLEAN, VERTICAL_RADIO, HORIZONTAL_RADIO, VERTICAL_CHECK, HORIZONTAL_CHECK, CODE, VAS. For each image in the list, the information included is:
  - image_info: A JSON string containing the information about the image
- file_info: (only in ITEMS of type "FILE" and "DEVICE". Provides extended information about the file uploaded. Introduced in API version 2.7.10
  - filename: Name of the file (includes name and file extension)
  - mime_type: MIME type of the file file. See MIME Types & File extensions for more information
  - url: A relative URL to download the file bytes via HTML5 Streaming
- options: if the question has options (question type is one of the following: BOOLEAN, VERTICAL_RADIO, HORIZONTAL_RADIO, VERTICAL_CHECK, HORIZONTAL_CHECK, CODE, VAS)
  - description: is the description of the option in the language of the session
  - value: is the value of the option
  - is_exclusive: (true/false) Only in ITEMS of type CHECKBOX. When true, it means that this option is selected, all the rest of options will be ignored (as if it was a radio button). Introduced in API version 2.7.21
  - option_id: is the ID of the option ( for RADIO, CHECK, COMBO)
  - image_info: if the option has an associated image (a LIBRARY RESOURCE), then this node will contain a JSON description of the resource. See LIBRARY RESOURCE INFO (JSON)
  - region_map: used when the question has an associated image. If this node has a value, it consists of a polygon defined on an image to let the user select this option by clicking on the specified zone of the image
  - mnemonic: a shortcut character that the UI can use to let the user select the option typing that character instead of clicking on it
- countdown: (Only in ITEMs of type "COUNTDOWN"). Returns the information to display a countdown control. Introduced in API version 2.7.16
  - start_time: Datetime when the regressive count starts
  - end_time: Datetime when the regressive count ends
  - duration: Total time in seconds between start_time and end_time
  - remaining: Time remaining (in seconds) from the active user time (in his timezone) until end_time
  - auto_refresh: A value in seconds that indicates the client application if a refresh of the FORM should be done. This is typically some ITEMS of the FORM are hidden or displayed while the countdown is running. This way the client application interface can reflect the changes in the ITEMS of the FORM while the countdown is running. Introduced in API version 2.7.20
- pkpass: (Only in ITEMs of type "QR"). An URL to download a Passbook Card file. Introduced in API version 2.7.17
- display_mode: Suggestion about how to present the question. The display mode depends on the configuration of the NAVIGATION_MODE property of the parent object (see ITEM TEMPLATE OBJECT). Introduced in API version 2.7.19. This property can have the following values:
  - 0: Default mode. The question should be presented in the default mode of the client application, which normally consists in presenting the question in a list along with the rest of questions of the same FORM
  - 1: Popup dialog: The question should be presented in a popup dialog
- auto_open: (true/false) This property is only returned in ITEMS of type TRAINER or ITEMS of type FORM configured to be displayed as a popup dialog (navigation mode = STEP BY STEP). When "auto_open = true", the client application should show automatically the contents of the embedded FORM. Otherwise, the user should perform some action (normally a mouse click) to open the contents of the embedded FORM. Introduced in API version 2.7.21
- display_time: Time (in seconds) that the ITEM should be displayed in the client application. Introduced in API Version 2.7.20.
  - In ITEMS of type COUNTDOWN, a value different than 0 means that the ITEM should be displayed until the end time of the countdown is reached.
  - In ITEMS of type MULTIMEDIA, a negative value means that the ITEM should be displayed until the reproduction ends. A positive value indicates a specific number of seconds
- repetitions: Information about the number of repetitions and the current repetition. This information is only provided if the ITEM TEMPLATE OBJECT used to generate this question has defined a number of repetitions. Introduced in API Version 2.7.20
  - current: Current repetition of the question
  - total: Total number of repetitions defined in the ITEM TEMPLATE
- previous_question: Information about the preceding question (can be used for navigation purposes in the UI). Introduced in API version 2.7.20
  - ref: reference of the previous question
  - form/ref: reference of the parent FORM of the previous question
  - task/ref: reference of the parent TASK of the previous question
- next_question: Information about the next question (can be used for navigation purposes in the UI). WARNING: if the current question is modified using form_set_answer (), the next question may vary due to changes in the conditions or visibility rules of the rest of questions in the same FORM. Introduced in API version 2.7.20
  - ref: reference of the previous question
  - form/ref: reference of the parent FORM of the previous question
  - task/ref: reference of the parent TASK of the previous question

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: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

form_get_question( “LCAAAAAAAAAAA”, “1234”, “{form_id/}1”);

Response

sample:

<?xml version="1.0" encoding="UTF-8"?>
<question>
  <form>
    <ref>9645</ref>
  </form>
  <task>
    <ref>5225</ref>
  </task>
  <question_id>12</question_id>
  <item_code>ALCOHOL</item_code>
  <order>1</order>
  <row></row>
  <column></column>
  <section_title>ENROLL QUESTIONNAIRE<section_title>
  <is_section_title>false<is_section_title>
  <description>How often have you had any alcoholic drink during the past 12 months?</description>
  <description_closed>Frequency having alcoholic drink</description_closed>
  <type>VERTICAL_RADIO</type>
  <data_code>ALCOHOLISM</data_code>
  <mandatory>Y</mandatory>
  <tabulation>0</tabulation>
  <exclusive>N</exclusive>
  <min_length>1</min_length>
  <max_length>32</max_length>
  <num_dec/>
  <tip>Press Enter to continue</tip>
  <multimedia_info>{"resource_ref":12312,"description":"Relaxing instructions","mimeType":"audio/mp3","code":"RELAXING","scope":"PROGRAM"}</multimedia_info>
  <image_list>
    <image_info>{"resource_ref":14324,"description":"","mimeType":"jpg","code":"","scope":"PROGRAM"}<image_info>
    <image_info>{"resource_ref":52324,"description":"","mimeType":"jpg","code":"","scope":"PROGRAM"}<image_info>
  </image_list>
  <options>
    <option>
      <description>Daily</description>
      <value>1</value>
      <option_id>NNN{|NNN}</option_id>
      <image_info>{"resource_ref":12312,"description":"Human body","mimeType":"jpg","code":"HUMAN_BODY","scope":"PROGRAM"}<image>
      <region_map>{"resource_ref":12312, "region":"54,23,56,45,123,542"}</region_map>
      <mnemonic>D</mnemonic>
    </option>
    <option>
      <description>5-6 days a week</description>
      <value>2</value>
      <option_id>NNN{|NNN}</option_id>
      <image></image>
      <mnemonic>A</mnemonic>
    </option>
    <option>
      <description>1-4 days a week</description>
      <value>3</value>
      <option_id>NNN{|NNN}</option_id>
      <image></image>
      <mnemonic>W</mnemonic>
    </option>
    <option>
      <description>1-3 days a month</description>
      <value>4</value>
      <option_id>NNN{|NNN}</option_id>
      <image></image>
      <mnemonic>M</mnemonic>
    </option>
    <option>
      <description>Less than once a month</description>
      <value>5</value>
      <option_id>NNN{|NNN}</option_id>
      <image></image>
      <mnemonic>L</mnemonic>
    </option>
    <option>
      <description>Not answered</description>
      <value>88</value>
      <option_id>NNN{|NNN}</option_id>
      <image></image>
      <mnemonic>N</mnemonic>
    </option>
  </options>
  <value/>
  <value_description/>
  <literal_format>{"text_format":"plain", "text-align":"left"}</literal_format>
  <value_format>{"text_format":"plain","text-align":"centre"}</value_format>
  <arrangement>{"answer_position":"below"}</arrangement>
  <constraint></constraint>
  <barcode_scan>0</barcode_scan>
  <nav_mode>0</nav_mode>
  <display_time>5</display_time>
  <repetitions>
    <current>1</current>
    <total>2</total>
  </repetitions>
  <editable>true</editable>
  <previous_question>
    <ref>11</ref>
    <form>
      <ref>9645</ref>
    </form>
    <task>
      <ref>5225</ref>
    </task>
  </previous_question>
</question>
<ErrorMsg></ErrorMsg>

Return Error codes

ERROR CODE
INVALID_TOKEN	The session token provided is not valid
QUESTION.NOT_FOUND	The FORM and QUESTION references provided in parameters form_id, question_id does not correspond to an existing ITEM

Browser not supported