Returned fields for the SurveyPage sub-object are explained below. Go to the Example Returns section to view return examples for each call type.
Returned Fields for the SurveyPage Object
| Field | Description | Format |
|---|---|---|
| id | ID of survey page | number |
| _type | API object type | string |
| title | Page title | string |
| description | Page description | string |
| questions | Array of questions. See SurveyQuestion Returned Fields for more info. | |
| Properties Fields | Description | Format |
| hidden | Indicates if page is hidden | boolean |
| piped_from | ID of question page is piped from | string |
Example Returns (.debug format)
- GetList Return Example
- Get SurveyPage Return Example
- Create SurveyPage Return Example
- Update SurveyPage Return Example
- Delete SurveyPage Return Example
GetList Return Example (.debug format):
Array
(
[result_ok] => 1
[total_count] => 2
[page] => 1
[total_pages] => 1
[results_per_page] => 2
[data] => Array
(
[0] => Array
(
[id] => 1
[_type] => SurveyPage
[title] => Array
(
[English] => Page One
)
[properties] => Array
(
[hidden] =>
)
[description] => Array
(
)
[questions] => Array
The remainder of the surveypage object get list return is an array of survey questions. See the SurveyQuestion object for more.
GetSurveyPage Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 1
[_type] => SurveyPage
[title] => Array
(
[English] => Page One
)
[properties] => Array
(
[hidden] =>
)
[description] => Array
(
)
[questions] => Array
The remainder of the surveypage get object return is an array of survey questions. See the SurveyQuestion object for more.
Create SurveyPage Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 3
[_type] => SurveyPage
[title] => Array
(
[English] =>
)
[properties] => Array
(
[hidden] =>
)
[description] => Array
(
)
[questions] => Array
(
)
)
)
Update SurveyPage Return Example (.debug format):
Array
(
[result_ok] => 1
[data] => Array
(
[id] => 19
[_type] => SurveyPage
[title] => Array
(
[English] =>
)
[properties] => Array
(
[hidden] =>
[piped_from] => 2
)
[description] => Array
(
)
[questions] => Array
(
)
)
)
Delete SurveyPage Return Example (.debug format):
Array
(
[result_ok] => 1
)