survey Web Service

survey

Click here for a complete list of operations.

returnSurvey

This method returns a survey and all of its details. Include the survey_no for a single result or set to 0 to return all.

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/returnSurvey"

<?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>
    <returnSurvey 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>
      <fields>
        <language>string</language>
        <dontAutoLoadFieldData>boolean</dontAutoLoadFieldData>
        <business_no>double</business_no>
        <includeAttributes>boolean</includeAttributes>
        <customer_no>double</customer_no>
        <hideFields>boolean</hideFields>
        <reference_type>string</reference_type>
        <publicOnly>boolean</publicOnly>
        <reference_no>double</reference_no>
        <survey_no>double</survey_no>
        <search_for>string</search_for>
        <company_no>double</company_no>
        <user_no>double</user_no>
        <isTemplate>boolean</isTemplate>
        <sortby>string</sortby>
        <totalResults>double</totalResults>
      </fields>
    </returnSurvey>
  </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>
    <returnSurveyResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <returnSurveyResult />
    </returnSurveyResponse>
  </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>
    <returnSurvey 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>
      <fields>
        <language>string</language>
        <dontAutoLoadFieldData>boolean</dontAutoLoadFieldData>
        <business_no>double</business_no>
        <includeAttributes>boolean</includeAttributes>
        <customer_no>double</customer_no>
        <hideFields>boolean</hideFields>
        <reference_type>string</reference_type>
        <publicOnly>boolean</publicOnly>
        <reference_no>double</reference_no>
        <survey_no>double</survey_no>
        <search_for>string</search_for>
        <company_no>double</company_no>
        <user_no>double</user_no>
        <isTemplate>boolean</isTemplate>
        <sortby>string</sortby>
        <totalResults>double</totalResults>
      </fields>
    </returnSurvey>
  </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>
    <returnSurveyResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <returnSurveyResult />
    </returnSurveyResponse>
  </soap12:Body>
</soap12:Envelope>