survey Web Service

survey

Click here for a complete list of operations.

createSurveyGroup

This method is used to create a new survey group.

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

<?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>
    <createSurveyGroup 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>
        <enableContinueVerify>boolean</enableContinueVerify>
        <application_password>string</application_password>
        <enableVerification>boolean</enableVerification>
        <application>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <invoiceOnFailure>boolean</invoiceOnFailure>
          <chargeDues>boolean</chargeDues>
          <membership_id>string</membership_id>
          <subscription_rate>double</subscription_rate>
          <payment_type>string</payment_type>
          <subscription_frequency>string</subscription_frequency>
          <autoSetup>boolean</autoSetup>
          <initiation_fee>double</initiation_fee>
          <chargeFees>boolean</chargeFees>
          <next_date>dateTime</next_date>
          <application_fee>double</application_fee>
          <transaction_no>double</transaction_no>
          <reference_title>string</reference_title>
          <reference_type>string</reference_type>
          <reference_no>double</reference_no>
          <survey_group_name>string</survey_group_name>
          <business_no>double</business_no>
          <card_no>double</card_no>
          <survey_application_no>double</survey_application_no>
          <survey_group_no>double</survey_group_no>
          <response_id>string</response_id>
          <account_user_no>double</account_user_no>
          <user_no>double</user_no>
          <affiliate_no>double</affiliate_no>
          <customer_no>double</customer_no>
          <company_no>double</company_no>
          <created_on>dateTime</created_on>
          <application_number>string</application_number>
          <expiration_date>dateTime</expiration_date>
          <application_notes>string</application_notes>
          <application_status>string</application_status>
          <customer>
            <lastVisit>dateTime</lastVisit>
            <totalVisits>double</totalVisits>
            <totalSpent>double</totalSpent>
            <isMember>boolean</isMember>
            <wasMember>boolean</wasMember>
            <hasApplied>boolean</hasApplied>
            <when_applied>dateTime</when_applied>
            <social xsi:nil="true" />
            <mobile_number_cc>string</mobile_number_cc>
            <phone_number_cc>string</phone_number_cc>
            <member_since>dateTime</member_since>
            <middle_name>string</middle_name>
            <membership_sku>string</membership_sku>
            <card_status>string</card_status>
            <membership_title>string</membership_title>
            <member_discount>double</member_discount>
            <points>double</points>
            <tag>string</tag>
            <cc_email>string</cc_email>
            <customer_source>string</customer_source>
            <username>string</username>
            <gender>string</gender>
            <company_title>string</company_title>
            <anniversary_date>dateTime</anniversary_date>
            <affiliate_no>double</affiliate_no>
            <membership_id>string</membership_id>
            <password>string</password>
            <passbook_enabled>string</passbook_enabled>
            <birthdate>dateTime</birthdate>
            <enableHouseAccount>boolean</enableHouseAccount>
            <opt_in_email>boolean</opt_in_email>
            <opt_in_sms>boolean</opt_in_sms>
            <customer_no>double</customer_no>
            <first_name>string</first_name>
            <last_name>string</last_name>
            <address>string</address>
            <address2>string</address2>
            <address3>string</address3>
            <city>string</city>
            <state>string</state>
            <zip_code>string</zip_code>
            <country>string</country>
            <company_name>string</company_name>
            <mobile_number>string</mobile_number>
            <phone_number>string</phone_number>
            <email>string</email>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <profile_photo>string</profile_photo>
            <customer_reference>string</customer_reference>
          </customer>
        </application>
        <require_confirm>boolean</require_confirm>
        <allow_edit>boolean</allow_edit>
        <application_fee>double</application_fee>
        <business_no>double</business_no>
        <company_name>string</company_name>
        <includeTitle>boolean</includeTitle>
        <visibility>string</visibility>
        <visibility_scope>string</visibility_scope>
        <response>
          <surveyResponseData>
            <survey_no>double</survey_no>
            <survey_name>string</survey_name>
            <response_data xsi:nil="true" />
          </surveyResponseData>
          <surveyResponseData>
            <survey_no>double</survey_no>
            <survey_name>string</survey_name>
            <response_data xsi:nil="true" />
          </surveyResponseData>
        </response>
        <customer_no>double</customer_no>
        <curStep>double</curStep>
        <page_no>double</page_no>
        <stats>
          <survey_taken>double</survey_taken>
          <questions_answered>double</questions_answered>
          <last_date>dateTime</last_date>
          <totalDay>double</totalDay>
          <totalWeek>double</totalWeek>
          <totalMonth>double</totalMonth>
          <totalYear>double</totalYear>
          <existing_customer>double</existing_customer>
          <totalApproved>double</totalApproved>
          <totalNew>double</totalNew>
          <totalWaiting>double</totalWaiting>
          <totalRejected>double</totalRejected>
          <totalViewed>double</totalViewed>
          <totalFlagged>double</totalFlagged>
          <totalCompleted>double</totalCompleted>
          <totalInProgress>double</totalInProgress>
        </stats>
        <assignments>
          <wi_survey_group_assign>
            <next_step>string</next_step>
            <company_no>double</company_no>
            <removeFlag>boolean</removeFlag>
            <reference_title>string</reference_title>
            <survey_group_assign_no>double</survey_group_assign_no>
            <survey_group_no>double</survey_group_no>
            <order_no>double</order_no>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </wi_survey_group_assign>
          <wi_survey_group_assign>
            <next_step>string</next_step>
            <company_no>double</company_no>
            <removeFlag>boolean</removeFlag>
            <reference_title>string</reference_title>
            <survey_group_assign_no>double</survey_group_assign_no>
            <survey_group_no>double</survey_group_no>
            <order_no>double</order_no>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </wi_survey_group_assign>
        </assignments>
        <includeAssignments>boolean</includeAssignments>
        <survey_group_no>double</survey_group_no>
        <survey_group_name>string</survey_group_name>
        <survey_group_summary>string</survey_group_summary>
        <survey_group_description>string</survey_group_description>
        <survey_group_status>string</survey_group_status>
        <created_on>dateTime</created_on>
        <user_no>double</user_no>
        <company_no>double</company_no>
        <modified_on>dateTime</modified_on>
        <modified_user_no>double</modified_user_no>
      </fields>
    </createSurveyGroup>
  </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>
    <createSurveyGroupResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <createSurveyGroupResult />
    </createSurveyGroupResponse>
  </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>
    <createSurveyGroup 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>
        <enableContinueVerify>boolean</enableContinueVerify>
        <application_password>string</application_password>
        <enableVerification>boolean</enableVerification>
        <application>
          <mobile_number>string</mobile_number>
          <customer_reference>string</customer_reference>
          <email>string</email>
          <invoiceOnFailure>boolean</invoiceOnFailure>
          <chargeDues>boolean</chargeDues>
          <membership_id>string</membership_id>
          <subscription_rate>double</subscription_rate>
          <payment_type>string</payment_type>
          <subscription_frequency>string</subscription_frequency>
          <autoSetup>boolean</autoSetup>
          <initiation_fee>double</initiation_fee>
          <chargeFees>boolean</chargeFees>
          <next_date>dateTime</next_date>
          <application_fee>double</application_fee>
          <transaction_no>double</transaction_no>
          <reference_title>string</reference_title>
          <reference_type>string</reference_type>
          <reference_no>double</reference_no>
          <survey_group_name>string</survey_group_name>
          <business_no>double</business_no>
          <card_no>double</card_no>
          <survey_application_no>double</survey_application_no>
          <survey_group_no>double</survey_group_no>
          <response_id>string</response_id>
          <account_user_no>double</account_user_no>
          <user_no>double</user_no>
          <affiliate_no>double</affiliate_no>
          <customer_no>double</customer_no>
          <company_no>double</company_no>
          <created_on>dateTime</created_on>
          <application_number>string</application_number>
          <expiration_date>dateTime</expiration_date>
          <application_notes>string</application_notes>
          <application_status>string</application_status>
          <customer>
            <lastVisit>dateTime</lastVisit>
            <totalVisits>double</totalVisits>
            <totalSpent>double</totalSpent>
            <isMember>boolean</isMember>
            <wasMember>boolean</wasMember>
            <hasApplied>boolean</hasApplied>
            <when_applied>dateTime</when_applied>
            <social xsi:nil="true" />
            <mobile_number_cc>string</mobile_number_cc>
            <phone_number_cc>string</phone_number_cc>
            <member_since>dateTime</member_since>
            <middle_name>string</middle_name>
            <membership_sku>string</membership_sku>
            <card_status>string</card_status>
            <membership_title>string</membership_title>
            <member_discount>double</member_discount>
            <points>double</points>
            <tag>string</tag>
            <cc_email>string</cc_email>
            <customer_source>string</customer_source>
            <username>string</username>
            <gender>string</gender>
            <company_title>string</company_title>
            <anniversary_date>dateTime</anniversary_date>
            <affiliate_no>double</affiliate_no>
            <membership_id>string</membership_id>
            <password>string</password>
            <passbook_enabled>string</passbook_enabled>
            <birthdate>dateTime</birthdate>
            <enableHouseAccount>boolean</enableHouseAccount>
            <opt_in_email>boolean</opt_in_email>
            <opt_in_sms>boolean</opt_in_sms>
            <customer_no>double</customer_no>
            <first_name>string</first_name>
            <last_name>string</last_name>
            <address>string</address>
            <address2>string</address2>
            <address3>string</address3>
            <city>string</city>
            <state>string</state>
            <zip_code>string</zip_code>
            <country>string</country>
            <company_name>string</company_name>
            <mobile_number>string</mobile_number>
            <phone_number>string</phone_number>
            <email>string</email>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <profile_photo>string</profile_photo>
            <customer_reference>string</customer_reference>
          </customer>
        </application>
        <require_confirm>boolean</require_confirm>
        <allow_edit>boolean</allow_edit>
        <application_fee>double</application_fee>
        <business_no>double</business_no>
        <company_name>string</company_name>
        <includeTitle>boolean</includeTitle>
        <visibility>string</visibility>
        <visibility_scope>string</visibility_scope>
        <response>
          <surveyResponseData>
            <survey_no>double</survey_no>
            <survey_name>string</survey_name>
            <response_data xsi:nil="true" />
          </surveyResponseData>
          <surveyResponseData>
            <survey_no>double</survey_no>
            <survey_name>string</survey_name>
            <response_data xsi:nil="true" />
          </surveyResponseData>
        </response>
        <customer_no>double</customer_no>
        <curStep>double</curStep>
        <page_no>double</page_no>
        <stats>
          <survey_taken>double</survey_taken>
          <questions_answered>double</questions_answered>
          <last_date>dateTime</last_date>
          <totalDay>double</totalDay>
          <totalWeek>double</totalWeek>
          <totalMonth>double</totalMonth>
          <totalYear>double</totalYear>
          <existing_customer>double</existing_customer>
          <totalApproved>double</totalApproved>
          <totalNew>double</totalNew>
          <totalWaiting>double</totalWaiting>
          <totalRejected>double</totalRejected>
          <totalViewed>double</totalViewed>
          <totalFlagged>double</totalFlagged>
          <totalCompleted>double</totalCompleted>
          <totalInProgress>double</totalInProgress>
        </stats>
        <assignments>
          <wi_survey_group_assign>
            <next_step>string</next_step>
            <company_no>double</company_no>
            <removeFlag>boolean</removeFlag>
            <reference_title>string</reference_title>
            <survey_group_assign_no>double</survey_group_assign_no>
            <survey_group_no>double</survey_group_no>
            <order_no>double</order_no>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </wi_survey_group_assign>
          <wi_survey_group_assign>
            <next_step>string</next_step>
            <company_no>double</company_no>
            <removeFlag>boolean</removeFlag>
            <reference_title>string</reference_title>
            <survey_group_assign_no>double</survey_group_assign_no>
            <survey_group_no>double</survey_group_no>
            <order_no>double</order_no>
            <reference_type>string</reference_type>
            <reference_no>double</reference_no>
          </wi_survey_group_assign>
        </assignments>
        <includeAssignments>boolean</includeAssignments>
        <survey_group_no>double</survey_group_no>
        <survey_group_name>string</survey_group_name>
        <survey_group_summary>string</survey_group_summary>
        <survey_group_description>string</survey_group_description>
        <survey_group_status>string</survey_group_status>
        <created_on>dateTime</created_on>
        <user_no>double</user_no>
        <company_no>double</company_no>
        <modified_on>dateTime</modified_on>
        <modified_user_no>double</modified_user_no>
      </fields>
    </createSurveyGroup>
  </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>
    <createSurveyGroupResponse xmlns="https://api.peoplevine.com/survey.asmx">
      <createSurveyGroupResult />
    </createSurveyGroupResponse>
  </soap12:Body>
</soap12:Envelope>