survey Web Service

survey

Click here for a complete list of operations.

answerSurvey

This method allows you to provide answers to a survey.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /survey.asmx HTTP/1.1
Host: api.peoplevine.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.peoplevine.com/survey.asmx/answerSurvey"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <answerSurvey xmlns="https://api.peoplevine.com/survey.asmx">
      <auth>
        <referenceTypes>
          <referenceType>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </referenceType>
          <referenceType>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </referenceType>
        </referenceTypes>
        <timezone_id>string</timezone_id>
        <locale>
          <currency>string</currency>
          <language>string</language>
          <country>string</country>
        </locale>
        <business_no>double</business_no>
        <customer_no>double</customer_no>
        <auth_method>string</auth_method>
        <timezone_offset>double</timezone_offset>
        <api_username>string</api_username>
        <api_password>string</api_password>
        <api_key>string</api_key>
        <auth_type>string</auth_type>
        <username>string</username>
        <password>string</password>
        <company_no>double</company_no>
        <system_name>string</system_name>
        <system_company_no>double</system_company_no>
        <ip_address>string</ip_address>
        <session_id>string</session_id>
        <device_type>string</device_type>
        <referrer>string</referrer>
        <user_info>string</user_info>
      </auth>
      <answers>
        <wi_survey_answers>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <submitted_customer_no>double</submitted_customer_no>
          <field_label>string</field_label>
          <survey_application_no>double</survey_application_no>
          <affiliate_no>double</affiliate_no>
          <survey_assign_no>double</survey_assign_no>
          <company_no>double</company_no>
          <survey_group_no>double</survey_group_no>
          <survey_answer_no>double</survey_answer_no>
          <survey_no>double</survey_no>
          <survey_field_no>double</survey_field_no>
          <customer_no>double</customer_no>
          <survey_answer>string</survey_answer>
          <response_id>string</response_id>
          <created_on>dateTime</created_on>
          <pass_no>double</pass_no>
          <survey_response_no>double</survey_response_no>
          <modified_on>dateTime</modified_on>
          <modified_user_no>double</modified_user_no>
          <modified_data>string</modified_data>
        </wi_survey_answers>
        <wi_survey_answers>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <submitted_customer_no>double</submitted_customer_no>
          <field_label>string</field_label>
          <survey_application_no>double</survey_application_no>
          <affiliate_no>double</affiliate_no>
          <survey_assign_no>double</survey_assign_no>
          <company_no>double</company_no>
          <survey_group_no>double</survey_group_no>
          <survey_answer_no>double</survey_answer_no>
          <survey_no>double</survey_no>
          <survey_field_no>double</survey_field_no>
          <customer_no>double</customer_no>
          <survey_answer>string</survey_answer>
          <response_id>string</response_id>
          <created_on>dateTime</created_on>
          <pass_no>double</pass_no>
          <survey_response_no>double</survey_response_no>
          <modified_on>dateTime</modified_on>
          <modified_user_no>double</modified_user_no>
          <modified_data>string</modified_data>
        </wi_survey_answers>
      </answers>
    </answerSurvey>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <answerSurveyResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <answerSurveyResult />
    </answerSurveyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /survey.asmx HTTP/1.1
Host: api.peoplevine.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <answerSurvey xmlns="https://api.peoplevine.com/survey.asmx">
      <auth>
        <referenceTypes>
          <referenceType>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </referenceType>
          <referenceType>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </referenceType>
        </referenceTypes>
        <timezone_id>string</timezone_id>
        <locale>
          <currency>string</currency>
          <language>string</language>
          <country>string</country>
        </locale>
        <business_no>double</business_no>
        <customer_no>double</customer_no>
        <auth_method>string</auth_method>
        <timezone_offset>double</timezone_offset>
        <api_username>string</api_username>
        <api_password>string</api_password>
        <api_key>string</api_key>
        <auth_type>string</auth_type>
        <username>string</username>
        <password>string</password>
        <company_no>double</company_no>
        <system_name>string</system_name>
        <system_company_no>double</system_company_no>
        <ip_address>string</ip_address>
        <session_id>string</session_id>
        <device_type>string</device_type>
        <referrer>string</referrer>
        <user_info>string</user_info>
      </auth>
      <answers>
        <wi_survey_answers>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <submitted_customer_no>double</submitted_customer_no>
          <field_label>string</field_label>
          <survey_application_no>double</survey_application_no>
          <affiliate_no>double</affiliate_no>
          <survey_assign_no>double</survey_assign_no>
          <company_no>double</company_no>
          <survey_group_no>double</survey_group_no>
          <survey_answer_no>double</survey_answer_no>
          <survey_no>double</survey_no>
          <survey_field_no>double</survey_field_no>
          <customer_no>double</customer_no>
          <survey_answer>string</survey_answer>
          <response_id>string</response_id>
          <created_on>dateTime</created_on>
          <pass_no>double</pass_no>
          <survey_response_no>double</survey_response_no>
          <modified_on>dateTime</modified_on>
          <modified_user_no>double</modified_user_no>
          <modified_data>string</modified_data>
        </wi_survey_answers>
        <wi_survey_answers>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <submitted_customer_no>double</submitted_customer_no>
          <field_label>string</field_label>
          <survey_application_no>double</survey_application_no>
          <affiliate_no>double</affiliate_no>
          <survey_assign_no>double</survey_assign_no>
          <company_no>double</company_no>
          <survey_group_no>double</survey_group_no>
          <survey_answer_no>double</survey_answer_no>
          <survey_no>double</survey_no>
          <survey_field_no>double</survey_field_no>
          <customer_no>double</customer_no>
          <survey_answer>string</survey_answer>
          <response_id>string</response_id>
          <created_on>dateTime</created_on>
          <pass_no>double</pass_no>
          <survey_response_no>double</survey_response_no>
          <modified_on>dateTime</modified_on>
          <modified_user_no>double</modified_user_no>
          <modified_data>string</modified_data>
        </wi_survey_answers>
      </answers>
    </answerSurvey>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <answerSurveyResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <answerSurveyResult />
    </answerSurveyResponse>
  </soap12:Body>
</soap12:Envelope>