Returned fields for the SurveyOption sub-object are explained below. Go to the Example Returns section to view return examples for each call type.
Returned Fields for the SurveyOption Object
| Field | Description | Format |
|---|---|---|
| id | Option ID | number |
| title | Option title | string |
| value | Reporting value | string |
| Properties Fields | Description | Format |
| disabled | Indicates answer option is disabled | boolean |
| dependent | Question IDs targeted in logic for this option | string |
| show_rules | Array of show/when logic rules | array |
| show_rules_logic_map | ||
| other | Indicates other special setting | boolean |
| otherrequired | Indicates other required special setting | boolean |
| na | Indicates not applicable special setting | boolean |
| none | Indicates none of the above special setting | boolean |
| all | Indicates all of the above special setting | boolean |
| fixed | Indicates fixed special setting | boolean |
| checked | Indicates checked special setting | boolean |
Example Returns (.debug format)
- GetList Return Example
- Get SurveyOption Return Example
- Create SurveyOption Return Example
- Update SurveyOption Return Example
- Delete Survey Option Return Example
GetList Return Example (.debug format):
Array
(
[result_ok] => 1
[total_count] => 3
[page] => 1
[total_pages] => 1
[results_per_page] => 3
[data] => Array
(
[0] => Array
(
[id] => 10001
[title] => Array
(
[English] => Yes
)
[value] => 1
[properties] => Array
(
[explorer_color] => 40A2C1
[disabled] =>
)
)
[1] => Array
(
[id] => 10002
[title] => Array
(
[English] => No
)
[value] => 0
[properties] => Array
(
[explorer_color] => 94C826
[disabled] =>
)
)
[2] => Array
(
[id] => 10003
[title] => Array
(
[English] => NA
)
[value] => 99
[properties] => Array
(
[explorer_color] => F5A417
[disabled] =>
)
)
)
)
Get SurveyOption Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 10001
[title] => Array
(
[English] => Yes
)
[value] => 1
[properties] => Array
(
[explorer_color] => 40A2C1
[disabled] =>
)
)
)
Create SurveyOption Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 10126
[title] => Array
(
[English] => Yes
)
[value] => 1
[properties] =>
)
)
Update SurveyOption Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 10126
[title] => Array
(
[English] => Yes
)
[value] => 2
[properties] =>
)
)
Delete SurveyOption Return Example (.debug format):
(
[result_ok] => 1
)