If_ResponseProp
The If_ResponseProp interface provides commands for managing
individual response and custom form resut (annex) records
|
| getcustid | | Returns/prints the customer ID from the session |
|
| lvarchar_001 | | Prints lvarchar_001 |
|
| lvarchar_002 | | Prints lvarchar_002 |
|
| lvarchar_003 | | Prints lvarchar_003 |
|
| lvarchar_004 | | Prints lvarchar_004 |
|
| lvarchar_005 | | Prints lvarchar_005 |
|
| lvarchar_006 | | Prints lvarchar_006 |
|
| lvarchar_007 | | Prints lvarchar_007 |
|
| lvarchar_008 | | Prints lvarchar_008 |
|
| lvarchar_009 | | Prints lvarchar_009 |
|
| lvarchar_010 | | Prints lvarchar_010 |
|
| varchar_001 | | Prints varchar_001 |
|
| varchar_002 | | Prints varchar_002 |
|
| varchar_003 | | Prints varchar_003 |
|
| varchar_004 | | Prints varchar_004 |
|
| varchar_005 | | Prints varchar_005 |
|
| varchar_006 | | Prints varchar_006 |
|
| varchar_007 | | Prints varchar_007 |
|
| varchar_008 | | Prints varchar_008 |
|
| varchar_009 | | Prints varchar_009 |
|
| varchar_010 | | Prints varchar_010 |
|
| varchar_011 | | Prints varchar_011 |
|
|
|
|
|
|
|
|
|
|
|
| grade | | Prints grade | | Functions used when this annex record is a response (template_id=10001) |
|
|
| username | | Prints users name |
|
| useremail | | Prints users email |
|
| Commands that are used for general annex management and properties |
|
| getid | | Returns and prints the annex ID (annex_id) |
|
| getkeyid | | Return & Prints the key_id of the annex record |
|
| date | | Prints & formats last modifified date |
|
| load | | This command loads an existing annex, returning 'yes' or 'no' depending on whether the order was loaded. | | | | Required arguments: | | owner_id - Owner ID of response (required) | | annex_id - annex ID of response to load | | *key_id - key ID of response to load | | *template_id - template ID of response to load | | | | *both required for them to be used | | | | Returns 'ok' or 'error:...' |
|
| checkifkey | | This command checks to see if the key_id already has an annex record for the template | | | | Arguments: | | key_id - Key ID (required) | | template_id - Template ID (required) |
|
| columncount | | This command counts how many columndef records exist for a template | | | | Arguments: | | template_id - Template ID (required) |
|
| visiblecolumncount | | This command counts how many columndef records exist for a template that are not hidden fields | | | | Arguments: | | template_id - Template ID (required) |
|
| correctcount | | This command sees how many correct answers are found in the test | | | | Arguments: | | key_id - Key ID (either key_id or annex_id required) | | annex_id - Annex ID (either key_id or annex_id required) | | template_id - Template ID (required) |
|
| getcurrentsurvey | | This command looks up the most current survey and returns its template_id | | | | Arguments: | | owner_id - Owner ID (required) |
|
| templateannexform | | This command creates the form used to input an annex record based on a template. | | | | Arguments: | | field_count - Number of items to display (default=all) | | template - Template format as below (required) | | hiddentemplate - Template used for hidden form fields (optional) | | show_results - Wheather to show results (optional, default=no) | | show_entry - Wheather to show entry (optional, default=yes) | | extra_html - Extra HTML arguments to put in the field tags (optional) | | option_prefix - Extra HTML arguments to put before each radio option (optional) | | option_postfix - Extra HTML arguments to put after each radio option (optional) | | result_prefix - Extra HTML arguments to put before each result option (optional) | | result_postfix - Extra HTML arguments to put after each result option (optional) | | key_id - Key ID (optional) | | template_id - Template ID (optional) | | show_count - Show a number in font of every question (optional, default=no) | | wrap_chars - if an option is mor than this then break to new line (optional) | | | | Template replacable macros: | | ##QUESTION## - Entry Title/Question | | ##ENTRY## - Form field html | | ##RESULT## - Form field html | | ##FIELDNAME## - Form field name | | ##NUMBER## - number in font of every question (if show_count = yes) | | | | Returns 'ok' or 'error:...' |
|
| templatehtmlform | | This command uses an existing html form to put values into | | | | Arguments: | | template - Template format as below (required) | | key_id - Key ID (optional) | | template_id - Template ID (optional) | | formatdates - format dates (yes/no) default=no | | | | Template replacable macros: | | ##INT_001## - ##INT_020## - integer fields | | ##DEC_001## - ##DEC_020## - decimal fields | | ##VARCHAR_001## - ##VARCHAR_020## - varchar fields | | ##LVARCHAR_001## - ##VARCHAR_020## - long varchar fields | | ##DATE_001## - ##DATE_020## - date fields | | ##DATETIME_001## - ##DATETIME_020## - date/time fields | | | | Returns 'ok' or 'error:...' |
|
| addresponse | | This command creates a new annex or updates an existing annex record. | | | | Optional arguments (all the fields default to empty): | | | | annex_name, (int_001 - int_010), (varchar_001 - varchar_010), (lvarchar_001 - lvarchar_010) | | | | gradeit = yes/no (optional, default=no) will put number into GRADED field if the field they entered has a * before it in the spec then put 1 into this field | | | | fields to use if this is a response: | | | | resp_subject - Response Subject | | linked_annex_id - Linked Response | | key_id - Linked Article Item ID | | field_text - Response Text | | | | Returns the 'ok' unless an error occurs. |
|
| printval | | Prints a field from the annex | | | | required arguments: | | owner_id | | template_id | | key_id | | column - the column name you want to print |
|