POST api/surveys/startByCulture?cultureId={cultureId}&oneQuestionPerPage={oneQuestionPerPage}&questionSetId={questionSetId}&version={version}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| cultureId | string |
Required |
|
| oneQuestionPerPage | boolean |
Required |
|
| questionSetId | string |
Required |
|
| version | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
StartDataProcessResult| Name | Description | Type | Additional information |
|---|---|---|---|
| survey | Survey |
None. |
|
| responses | Dictionary of string [key] and QuestionResponse [value] |
None. |
|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| ErrorPage | string |
None. |
|
| metadata | MetaDataResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"survey": {
"element_type": "Survey",
"id": "sample string 1",
"category_name": "sample string 2",
"revision_id": "sample string 3",
"sections": [
{
"element_type": "Section",
"section_type": "sample string 1",
"id": 2,
"title": "sample string 3",
"has_filter": true,
"pages": [
{
"element_type": "page",
"title": "sample string 1",
"has_filter": true,
"id": "sample string 3",
"questions": null,
"page_type": 0
},
{
"element_type": "page",
"title": "sample string 1",
"has_filter": true,
"id": "sample string 3",
"questions": null,
"page_type": 0
}
]
},
{
"element_type": "Section",
"section_type": "sample string 1",
"id": 2,
"title": "sample string 3",
"has_filter": true,
"pages": [
{
"element_type": "page",
"title": "sample string 1",
"has_filter": true,
"id": "sample string 3",
"questions": null,
"page_type": 0
},
{
"element_type": "page",
"title": "sample string 1",
"has_filter": true,
"id": "sample string 3",
"questions": null,
"page_type": 0
}
]
}
],
"title": "sample string 4",
"instance_id": "sample string 5",
"rules": [
{
"element_type": "rule",
"id": "sample string 1",
"conditions": null,
"actions": null,
"survey_id": "sample string 2",
"order": 3,
"ups_termination_code_id": "sample string 4"
},
{
"element_type": "rule",
"id": "sample string 1",
"conditions": null,
"actions": null,
"survey_id": "sample string 2",
"order": 3,
"ups_termination_code_id": "sample string 4"
}
],
"containers": [
{
"element_type": "questions_container",
"id": "sample string 1",
"title": "sample string 2",
"description": "sample string 3",
"alignment_mode": "sample string 4",
"has_validation": true
},
{
"element_type": "questions_container",
"id": "sample string 1",
"title": "sample string 2",
"description": "sample string 3",
"alignment_mode": "sample string 4",
"has_validation": true
}
],
"has_targeting": true,
"has_redirect_links": true,
"operational_quotas": {},
"piping_infos": [
{},
{}
],
"piping_answers": [
{},
{}
],
"quotaStatus": {}
},
"responses": {
"sample string 1": null,
"sample string 2": null
},
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"ErrorPage": "sample string 3",
"metadata": {
"ignore_navigation_to_last_page_visited": true,
"custom_post_rv_url": "sample string 2",
"filtered_answers_url": "sample string 3",
"container_validation_url": "sample string 4",
"container_id_to_validation_types": {
"sample string 1": null,
"sample string 2": null
},
"survey_augmented_info": {
"GridQuestionToCellsMappings": {
"1": [
{
"RowAndCol": {
"row": "sample string 1",
"col": "sample string 2"
},
"QuestionAnswer": {
"QuestionId": 1,
"AnswerId": 2
}
},
{
"RowAndCol": {
"row": "sample string 1",
"col": "sample string 2"
},
"QuestionAnswer": {
"QuestionId": 1,
"AnswerId": 2
}
}
],
"2": [
{
"RowAndCol": {
"row": "sample string 1",
"col": "sample string 2"
},
"QuestionAnswer": {
"QuestionId": 1,
"AnswerId": 2
}
},
{
"RowAndCol": {
"row": "sample string 1",
"col": "sample string 2"
},
"QuestionAnswer": {
"QuestionId": 1,
"AnswerId": 2
}
}
]
},
"FilteredAnswersChildToParents": {
"1": [
1,
2
],
"2": [
1,
2
]
},
"MatrixQuestionIDToRowsAndColumns": {
"1": {
"Rows": [
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
},
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
}
],
"Columns": [
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
},
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
}
]
},
"2": {
"Rows": [
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
},
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
}
],
"Columns": [
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
},
{
"contains_textual_input": true,
"id": "sample string 2",
"title": "sample string 3",
"multimedia": {
"multimedia_type": 0,
"url": "sample string 1"
},
"is_exclusive": true,
"mutual_exclusion_type": "sample string 5"
}
]
}
}
}
}
}
application/xml, text/xml
Sample:
<StartDataProcessResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.ProfileFlows.Start">
<ErrorMessage>sample string 2</ErrorMessage>
<ErrorPage>sample string 3</ErrorPage>
<IsSuccessful>true</IsSuccessful>
<metadata>
<container_id_to_validation_types xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringanyType>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value i:nil="true" />
</d3p1:KeyValueOfstringanyType>
<d3p1:KeyValueOfstringanyType>
<d3p1:Key>sample string 2</d3p1:Key>
<d3p1:Value i:nil="true" />
</d3p1:KeyValueOfstringanyType>
</container_id_to_validation_types>
<container_validation_url>sample string 4</container_validation_url>
<custom_post_rv_url>sample string 2</custom_post_rv_url>
<filtered_answers_url>sample string 3</filtered_answers_url>
<ignore_navigation_to_last_page_visited>true</ignore_navigation_to_last_page_visited>
<survey_augmented_info xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.SurveyMeta">
<d3p1:FilteredAnswersChildToParents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfintArrayOfintty7Ep6D1>
<d4p1:Key>1</d4p1:Key>
<d4p1:Value>
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d4p1:Value>
</d4p1:KeyValueOfintArrayOfintty7Ep6D1>
<d4p1:KeyValueOfintArrayOfintty7Ep6D1>
<d4p1:Key>2</d4p1:Key>
<d4p1:Value>
<d4p1:int>1</d4p1:int>
<d4p1:int>2</d4p1:int>
</d4p1:Value>
</d4p1:KeyValueOfintArrayOfintty7Ep6D1>
</d3p1:FilteredAnswersChildToParents>
<d3p1:GridQuestionToCellsMappings xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfintArrayOfGridCellMappingItem1sd9HJWW>
<d4p1:Key>1</d4p1:Key>
<d4p1:Value>
<d3p1:GridCellMappingItem>
<d3p1:QuestionAnswer>
<d3p1:AnswerId>2</d3p1:AnswerId>
<d3p1:QuestionId>1</d3p1:QuestionId>
</d3p1:QuestionAnswer>
<d3p1:RowAndCol>
<d3p1:col>sample string 2</d3p1:col>
<d3p1:row>sample string 1</d3p1:row>
</d3p1:RowAndCol>
</d3p1:GridCellMappingItem>
<d3p1:GridCellMappingItem>
<d3p1:QuestionAnswer>
<d3p1:AnswerId>2</d3p1:AnswerId>
<d3p1:QuestionId>1</d3p1:QuestionId>
</d3p1:QuestionAnswer>
<d3p1:RowAndCol>
<d3p1:col>sample string 2</d3p1:col>
<d3p1:row>sample string 1</d3p1:row>
</d3p1:RowAndCol>
</d3p1:GridCellMappingItem>
</d4p1:Value>
</d4p1:KeyValueOfintArrayOfGridCellMappingItem1sd9HJWW>
<d4p1:KeyValueOfintArrayOfGridCellMappingItem1sd9HJWW>
<d4p1:Key>2</d4p1:Key>
<d4p1:Value>
<d3p1:GridCellMappingItem>
<d3p1:QuestionAnswer>
<d3p1:AnswerId>2</d3p1:AnswerId>
<d3p1:QuestionId>1</d3p1:QuestionId>
</d3p1:QuestionAnswer>
<d3p1:RowAndCol>
<d3p1:col>sample string 2</d3p1:col>
<d3p1:row>sample string 1</d3p1:row>
</d3p1:RowAndCol>
</d3p1:GridCellMappingItem>
<d3p1:GridCellMappingItem>
<d3p1:QuestionAnswer>
<d3p1:AnswerId>2</d3p1:AnswerId>
<d3p1:QuestionId>1</d3p1:QuestionId>
</d3p1:QuestionAnswer>
<d3p1:RowAndCol>
<d3p1:col>sample string 2</d3p1:col>
<d3p1:row>sample string 1</d3p1:row>
</d3p1:RowAndCol>
</d3p1:GridCellMappingItem>
</d4p1:Value>
</d4p1:KeyValueOfintArrayOfGridCellMappingItem1sd9HJWW>
</d3p1:GridQuestionToCellsMappings>
<d3p1:MatrixQuestionIDToRowsAndColumns xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfintMatrixQuestionRowsAndColumns1sd9HJWW>
<d4p1:Key>1</d4p1:Key>
<d4p1:Value>
<d3p1:Columns xmlns:d7p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects">
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
</d3p1:Columns>
<d3p1:Rows xmlns:d7p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects">
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
</d3p1:Rows>
</d4p1:Value>
</d4p1:KeyValueOfintMatrixQuestionRowsAndColumns1sd9HJWW>
<d4p1:KeyValueOfintMatrixQuestionRowsAndColumns1sd9HJWW>
<d4p1:Key>2</d4p1:Key>
<d4p1:Value>
<d3p1:Columns xmlns:d7p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects">
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
</d3p1:Columns>
<d3p1:Rows xmlns:d7p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects">
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
<d7p1:RuntimeMatrixRowCol>
<d7p1:id>sample string 2</d7p1:id>
<d7p1:is_exclusive>true</d7p1:is_exclusive>
<d7p1:multimedia>
<d7p1:multimedia_type>picture</d7p1:multimedia_type>
<d7p1:url>sample string 1</d7p1:url>
</d7p1:multimedia>
<d7p1:mutual_exclusion_type>sample string 5</d7p1:mutual_exclusion_type>
<d7p1:title>sample string 3</d7p1:title>
<d7p1:contains_textual_input>true</d7p1:contains_textual_input>
</d7p1:RuntimeMatrixRowCol>
</d3p1:Rows>
</d4p1:Value>
</d4p1:KeyValueOfintMatrixQuestionRowsAndColumns1sd9HJWW>
</d3p1:MatrixQuestionIDToRowsAndColumns>
</survey_augmented_info>
</metadata>
<responses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringQuestionResponseXShtVwaz>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects" i:nil="true" />
</d2p1:KeyValueOfstringQuestionResponseXShtVwaz>
<d2p1:KeyValueOfstringQuestionResponseXShtVwaz>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects" i:nil="true" />
</d2p1:KeyValueOfstringQuestionResponseXShtVwaz>
</responses>
<survey xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProfilesRuntimeMediator.RuntimeObjects">
<d2p1:category_name>sample string 2</d2p1:category_name>
<d2p1:containers>
<d2p1:RuntimeContainer>
<d2p1:alignment_mode>sample string 4</d2p1:alignment_mode>
<d2p1:description>sample string 3</d2p1:description>
<d2p1:has_validation>true</d2p1:has_validation>
<d2p1:id>sample string 1</d2p1:id>
<d2p1:title>sample string 2</d2p1:title>
</d2p1:RuntimeContainer>
<d2p1:RuntimeContainer>
<d2p1:alignment_mode>sample string 4</d2p1:alignment_mode>
<d2p1:description>sample string 3</d2p1:description>
<d2p1:has_validation>true</d2p1:has_validation>
<d2p1:id>sample string 1</d2p1:id>
<d2p1:title>sample string 2</d2p1:title>
</d2p1:RuntimeContainer>
</d2p1:containers>
<d2p1:has_redirect_links>true</d2p1:has_redirect_links>
<d2p1:has_targeting>true</d2p1:has_targeting>
<d2p1:id>sample string 1</d2p1:id>
<d2p1:instance_id>sample string 5</d2p1:instance_id>
<d2p1:operational_quotas />
<d2p1:piping_answers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
<d3p1:anyType />
</d2p1:piping_answers>
<d2p1:piping_infos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:anyType />
<d3p1:anyType />
</d2p1:piping_infos>
<d2p1:quotaStatus />
<d2p1:revision_id>sample string 3</d2p1:revision_id>
<d2p1:rules>
<d2p1:Rule>
<d2p1:actions i:nil="true" />
<d2p1:conditions i:nil="true" />
<d2p1:id>sample string 1</d2p1:id>
<d2p1:order>3</d2p1:order>
<d2p1:survey_id>sample string 2</d2p1:survey_id>
<d2p1:ups_termination_code_id>sample string 4</d2p1:ups_termination_code_id>
</d2p1:Rule>
<d2p1:Rule>
<d2p1:actions i:nil="true" />
<d2p1:conditions i:nil="true" />
<d2p1:id>sample string 1</d2p1:id>
<d2p1:order>3</d2p1:order>
<d2p1:survey_id>sample string 2</d2p1:survey_id>
<d2p1:ups_termination_code_id>sample string 4</d2p1:ups_termination_code_id>
</d2p1:Rule>
</d2p1:rules>
<d2p1:sections>
<d2p1:Section>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>2</d2p1:id>
<d2p1:pages>
<d2p1:Page>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>sample string 3</d2p1:id>
<d2p1:page_type>page</d2p1:page_type>
<d2p1:questions i:nil="true" />
<d2p1:title>sample string 1</d2p1:title>
</d2p1:Page>
<d2p1:Page>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>sample string 3</d2p1:id>
<d2p1:page_type>page</d2p1:page_type>
<d2p1:questions i:nil="true" />
<d2p1:title>sample string 1</d2p1:title>
</d2p1:Page>
</d2p1:pages>
<d2p1:section_type>sample string 1</d2p1:section_type>
<d2p1:title>sample string 3</d2p1:title>
</d2p1:Section>
<d2p1:Section>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>2</d2p1:id>
<d2p1:pages>
<d2p1:Page>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>sample string 3</d2p1:id>
<d2p1:page_type>page</d2p1:page_type>
<d2p1:questions i:nil="true" />
<d2p1:title>sample string 1</d2p1:title>
</d2p1:Page>
<d2p1:Page>
<d2p1:has_filter>true</d2p1:has_filter>
<d2p1:id>sample string 3</d2p1:id>
<d2p1:page_type>page</d2p1:page_type>
<d2p1:questions i:nil="true" />
<d2p1:title>sample string 1</d2p1:title>
</d2p1:Page>
</d2p1:pages>
<d2p1:section_type>sample string 1</d2p1:section_type>
<d2p1:title>sample string 3</d2p1:title>
</d2p1:Section>
</d2p1:sections>
<d2p1:title>sample string 4</d2p1:title>
</survey>
</StartDataProcessResult>