SurveyOption Returned Fields

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

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 sku number
_type API object type string
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 (.debug format):

Array
(
    [result_ok] => 1
    [total_count] => 4
    [page] => 1
    [total_pages] => 1
    [results_per_page] => 4
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 10003
                    [_type] => SurveyOption
                    [title] => Array
                        (
                            [English] => Dog
                        )

                    [value] => Dog
                    [properties] => Array
                        (
                            [disabled] =>
                            [dependent] => 4,5
                            [show_rules] =>
                            [show_rules_logic_map] => :522b891d06e34,522b891d0721f
                        )

                )

Get SurveyOption Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 10003
            [_type] => SurveyOption
            [title] => Array
                (
                    [English] => Dog
                )

            [value] => Dog
            [properties] => Array
                (
                    [disabled] =>
                    [dependent] => 4,5
                    [show_rules] =>
                    [show_rules_logic_map] => :522b891d06e34,522b891d0721f
                )

        )

)

Create SurveyOption Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 10271
            [_type] => SurveyOption
            [title] => Array
                (
                    [English] => Other
                )

            [value] => Other
            [properties] => Array
                (
                    [other] => true
                )

        )

)

Update SurveyOption Return Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 10270
            [_type] => SurveyOption
            [title] => Array
                (
                    [English] => Reptile
                )

            [value] => Reptile
            [properties] => Array
                (
                    [disabled] =>
                    [show_rules] =>
                    [show_rules_logic_map] => :522b9ba7dcd6b,522b9ba7dd152
                    [dependent] => 4,5
                )

        )

)

Delete SurveyOption Return Example (.debug format):

(
    [result_ok] => 1
)