PAIN DETAILS

{"type":"doc","content":[{"type":"paragraph"},{"type":"table","attrs":{"layout":"wide","width":770.77215,"localId":"fac867af-dccb-4a64-90cc-0f21064a792c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.37]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[584.41]},"content":[{"type":"paragraph","content":[{"text":"form_get_summary ( session, form, question)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[186.37]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[584.41]},"content":[{"type":"paragraph","content":[{"text":"2.7.24 and higher","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]}]}]}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"3acdccd6-e2c0-417f-b9c8-bda3556d49b4"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[508.0,1291.0]},"content":[{"type":"paragraph","content":[{"text":"Generates a summary with the ITEMS of a FORM that belong to an array of ITEMS","type":"text"}]},{"type":"paragraph","content":[{"text":"The questions included in the response depend on the state of the FORM:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the FORM is in OPEN state, then return all the questions that are always visible (not hidden) and not marked as 'HIDDEN ON OPEN' (see HIDDEN property of ","type":"text"},{"text":"ITEM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/579829764"}}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the FORM is in CLOSED state, then return all the questions that are always visible (not hidden) and not marked as 'HIDDEN ON CLOSE' (see HIDDEN property of ","type":"text"},{"text":"ITEM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/579829764"}}]},{"text":")","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[508.0]},"content":[{"type":"paragraph","content":[{"text":"Input","type":"text"}]},{"type":"paragraph","content":[{"text":"parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1291.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"session","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the session id obtained in the session_init call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"form","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the ID of the form obtained by the URL or by the call ","type":"text"},{"text":"form_list()","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"question","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"reference to any question of the array for which we are requesting the summary","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[508.0]},"content":[{"type":"paragraph","content":[{"text":"Output","type":"text"}]},{"type":"paragraph","content":[{"text":"parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1291.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML with the information about the FORM:","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"question_array","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is an XML with a all details of the questions of the array. The XML form is more similar than the template XML. For more information see the ","type":"text"},{"text":"template_import()","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the reference of the array","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"title","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Title of the array","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rows","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Number of rows of the array","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Number of columns of the array","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"new_row_ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Represents the ITEM Id that should be used if you want to populate a new row of the array. You can invoke ","type":"text"},{"text":"form_get_question ( )","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/524422"}}]},{"text":" and ","type":"text"},{"text":"form_set_answer ()","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/524483"}}]},{"text":" using this reference.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"headers","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": list of header titles of the array. ","type":"text"},{"text":"Introduced in API version 2.7.25","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"header","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Number of column. Note that this value may not be sequential. It corresponds to the number of column of the questions as defined in the FORM TEMPLATE","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": title of the column","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"questions","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": list of ITEMS in the FORM","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"question_id","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": a question reference of the type {form_id/}question_id","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"item_code","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": ITEM CODE of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"question_template_id","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": ID of the ","type":"text"},{"text":"ITEM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/579829764"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": the text of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description_onedit","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": the text of the question that must be shown when editing the FORM. If empty, \"description\" will be used","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"literal_format","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": rules to format the text of the question. See ","type":"text"},{"text":"FORM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260257"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value_format","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": rules to format the value (answer) of the question. See ","type":"text"},{"text":"FORM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260257"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"arrangement","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": rules to determine the position of the answer respect to the text of the question (below, beside...). See ","type":"text"},{"text":"FORM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/4260257"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"barcode_scan","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Indicates whether the value of this question is allowed to be entered by scanning a barcode (see ","type":"text"},{"text":"BARCODE_SCAN PROPERTY","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/579829764#ITEMTEMPLATEOBJECT-BARCODE_SCAN"}}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"order","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"row","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": only for ARRAYS. Determines the row to into an ARRAY to which this question belongs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"column","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": only for ARRAYS. Determines the column to into an ARRAY to which this question belongs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"empty_row","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (0 / 1) Only in ARRAYS. indicates whether the question belongs to an empty row of the ARRAY","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"data_code","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": the data_code of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"question_name","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the name of the question in the session language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the answer of the user","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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, FORM","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"is_section_title","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Only in STATIC_TEXT question types. Indicates that the STATIC TEXT ITEM should be considered as the caption of a section (and all the ITEMS following this one are considered to belong to the section until another section title appears)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"section_title","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": This property has value in the following situations:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the question is placed after a STATIC_TEXT marked as 'section_title' (i.e. ","type":"text"},{"text":"is_section_title","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" = true). The value will be the description of the closest section title ITEM.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the question belongs to an embedded FORM. Embedded FORMs are represented by a special ","type":"text"},{"text":"ITEM of type \"FORM\"","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/652247113"}}]},{"text":" which is included in the FORM referenced by the parameter ","type":"text"},{"text":"form","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":". The value of ","type":"text"},{"text":"section_title","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" will be the description of the ","type":"text"},{"text":"ITEM of type \"FORM\"","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/652247113"}}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"device_type","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": when the 'type' of the question is DEVICE, then it is also included the 'device_type' indicating the ","type":"text"},{"text":"DEVICE TYPE CODE","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/96129439"}}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mandatory","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Y for yes N for no","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tabulation","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the tabulation of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"min_value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (only if the question type is NUMERICAL). Minimum value accepted for the answer of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"max_value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (only if the question type is NUMERICAL). Maximum value accepted for the answer of the question","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value_increment","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" (only when question type is VAS): defines the minimum increment that can be applied to the value","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"min_length","type":"text","marks":[{"type":"strong"}]},{"text":": (only if it has a value) the minimum character length admitted","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"max_length","type":"text","marks":[{"type":"strong"}]},{"text":": (only if it has a value) the maximum character length admitted ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"num_dec","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": number of decimals","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"formula","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": if the result is a formula","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"multimedia_info","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": only in MULTIMEDIA questions. Returns the information of the ","type":"text"},{"text":"LIBRARY RESOURCE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/580714692"}}]},{"text":" that contains the multimedia resource associated to the question (audio or video)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"image_list","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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 parameter ","type":"text"},{"text":"with_options","type":"text","marks":[{"type":"em"}]},{"text":" is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"strong"}]},{"text":" and 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:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"image_info: A JSON string containing the information about the image ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"file_info","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (only in ITEMS of type \"FILE\" and \"DEVICE\". Provides extended information about the file uploaded.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"filename","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Name of the file (includes name and file extension)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mime_type","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": MIME type of the file file. ","type":"text"},{"text":"See ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]},{"text":"MIME Types & File extensions","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/627048517"}}]},{"text":" for more information","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"url","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": A relative URL to download the file bytes via HTML5 Streaming","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Contains the list of options that the user can select as a response. This node will only be included when parameter ","type":"text"},{"text":"with_options","type":"text","marks":[{"type":"em"}]},{"text":" is ","type":"text"},{"text":"true","type":"text","marks":[{"type":"strong"}]},{"text":" and the question type is one of the following: BOOLEAN, VERTICAL_RADIO, HORIZONTAL_RADIO, VERTICAL_CHECK, HORIZONTAL_CHECK, CODE, VA","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the description of the option in the language of the session","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the value of the option","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"is_exclusive","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (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).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"option_id","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the ID of the option ( for RADIO, CHECK, COMBO)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"image_info","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": if the option has an associated image (a LIBRARY RESOURCE), then this node will contain a JSON description of the resource. See ","type":"text"},{"text":"LIBRARY RESOURCE INFO (JSON)","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/583696435"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"region_map","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the value of the option. If there are multiple options. Is the description of the option selected.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"countdown","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (Only in ITEMs of type \"COUNTDOWN\"). Returns the information to display a countdown control.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"start_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Datetime when the regressive count starts","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"end_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Datetime when the regressive count ends","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"duration","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Total time in seconds between ","type":"text"},{"text":"start_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" and ","type":"text"},{"text":"end_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"remaining","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Time remaining (in seconds) from the active user time (in his timezone) until ","type":"text"},{"text":"end_time","type":"text","marks":[{"type":"strong"},{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"auto_refresh","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pkpass","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (Only in ITEMs of type \"QR\"). An URL to download a Passbook Card file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"display_mode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Suggestion about how to present the question. The display mode depends on the configuration of the NAVIGATION_MODE property of the parent object (see ","type":"text"},{"text":"ITEM TEMPLATE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"https://linkcare.atlassian.net/wiki/spaces/WS/pages/579829764"}}]},{"text":"). This property can have the following values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1: Popup dialog: The question should be presented in a popup dialog","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"auto_open","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (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.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"display_time","type":"text","marks":[{"type":"strong"}]},{"text":": Time (in seconds) that the ITEM should be displayed in the client application.","type":"text"},{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"editable","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (true/false) Indicates whether the active session can modify the value of the question.","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorMsg","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": 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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorCode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains any of the standard ","type":"text"},{"text":"ERROR CODES","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/55967818/ERROR+CODES"}}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[508.0]},"content":[{"type":"paragraph","content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"text":"sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1291.0]},"content":[{"type":"paragraph","content":[{"text":"form_get_array_summary( “LCAAAAAAAAAAA”, 1234, 32);","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[508.0]},"content":[{"type":"paragraph","content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"sample:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1291.0]},"content":[{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\n \n 1234\n PAIN DETAILS\n 1\n 3\n 4\n \n

\n 1\n PAIN DESCRIPTION\n

\n 3\n Expected start date\n

\n 4\n Expected stop date\n

\n \n \n \n 1\n \n 1\n 1\n 1\n N\n N\n 0\n PAIN DESCRIPTION\n PAIN DESCRIPTION\n {\"text_format\":\"plain\", \"text-align\":\"left\"}\n {\"text_format\":\"plain\",\"text-align\":\"centre\"}\n \n \n 0\n \n STATIC_TEXT\n false\n \n 0\n 5\n \n \n 2\n 2\n 1\n 3\n \n 1\n 32\n (MM/DD/YYYY)\n 11/22/2015\n N\n N\n 0\n Expected start date\n Please indicate the day when patient will start sending information\n {\"text_format\":\"plain\", \"text-align\":\"left\"}\n {\"text_format\":\"plain\",\"text-align\":\"centre\"}\n {\"answer_position\":\"below\"}\n \n 0\n START\n DATE\n false\n 11/22/2015\n 0\n \n \n 3\n 3\n 1\n 4\n \n \n N\n N\n 0\n Expected stop date\n Please indicate the day when patient will stop sending information\n {\"text_format\":\"plain\", \"text-align\":\"left\"}\n {\"text_format\":\"plain\",\"text-align\":\"centre\"}\n {\"answer_position\":\"below\"}\n \n 0\n PAIN_ZONE\n VERTICAL_RADIO\n {\"resource_ref\":12312,\"description\":\"Relaxing instructions\",\"mimeType\":\"audio/mp3\",\"code\":\"RELAXING\",\"scope\":\"PROGRAM\"}\n \n \n {\"resource_ref\":12312,\"description\":\"Human body\",\"mimeType\":\"jpg\",\"code\":\"HUMAN_BODY\",\"scope\":\"PROGRAM\"}\n \n \n 2\n Elbow\n {\"resource_ref\":12312,\"description\":\"Elbow\",\"mimeType\":\"jpg\",\"code\":\"HUMAN_BODY_ELBOW\",\"scope\":\"PROGRAM\"}\n 0\n \n \n \n\n\n\n\n","type":"text"}]},{"type":"paragraph"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"0d9d2036-218b-4c04-906e-d0f537f01192"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph","content":[{"text":"The session token provided is not valid","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"INSUFFICIENT_PRIVILEGES","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph","content":[{"text":"The session user does not have the necessary privileges to create request the ","type":"text"},{"text":"form","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" indicated","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"FORM.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph","content":[{"text":"The FORM reference provided in parameter ","type":"text"},{"text":"form","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" does not correspond to an existing FORM","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"QUESTION.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph","content":[{"text":"The ITEM reference provided in parameter ","type":"text"},{"text":"question","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" does not correspond to an existing ITEM","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"QUESTION.NOT_ARRAY","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1379.0]},"content":[{"type":"paragraph","content":[{"text":"The reference provided in ","type":"text"},{"text":"question","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" does not correspond to a question in an array","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported