POST api/surveys/complete?surveyStartDataEncrypted={surveyStartDataEncrypted}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyStartDataEncrypted

string

Required

Body Parameters

SurveyCompletionInfo
NameDescriptionTypeAdditional information
responseVector

Dictionary of string [key] and QuestionResponse [value]

None.

upsTerminationCode

integer

None.

responseVectorChanged

boolean

None.

fdsStartData

string

None.

Request Formats

application/json, text/json

Sample:
{
  "responseVector": {
    "sample string 1": null,
    "sample string 2": null
  },
  "upsTerminationCode": 1,
  "responseVectorChanged": true,
  "fdsStartData": "sample string 3"
}

application/xml, text/xml

Sample:
<SurveyCompletionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.ProfileFlows.Complete">
  <fdsStartData>sample string 3</fdsStartData>
  <responseVector 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>
  </responseVector>
  <responseVectorChanged>true</responseVectorChanged>
  <upsTerminationCode>1</upsTerminationCode>
</SurveyCompletionInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SurveyCompleteResult
NameDescriptionTypeAdditional information
survey

Survey

None.

responses

Dictionary of string [key] and QuestionResponse [value]

None.

IsSuccessful

boolean

None.

ErrorMessage

string

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"
}

application/xml, text/xml

Sample:
<SurveyCompleteResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Toluna.ProfileFlows.Complete">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <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>
</SurveyCompleteResult>