Get Survey types

Description

Retrieves the list of supported survey types

HTTP Method

GET

Path

/campaign/{campaignId}/surveyTypes

Authentication

Does not require user authentication.

Parameters

Table 10.  Parameters for " Get Survey types "

NameTypeValue TypeDescription
campaignIdPATHlongID of the campaign to get the surveys.

Error Codes

150000 ( Common )

An unhandled exception has occured.

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="surveyType">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:SurveyTypeBase">
          <xs:sequence/>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="surveyTypes">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="surveyType" type="tns:SurveyTypeBase" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="SurveyTypeBase">
    <xs:sequence>
      <xs:element name="surveyTypeId" type="xs:long"/>
      <xs:element name="parentSurveyTypeId" type="xs:long"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="campaignId" type="xs:long"/>
      <xs:element name="position" type="xs:long" minOccurs="0"/>
      <xs:element name="category" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="categoryId" type="xs:long"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="objectType" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="objectTypeId" type="xs:long"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<surveyTypes xmlns="http://xsd.poken.com">
		<surveyType>
				<surveyTypeId>1</surveyTypeId>
				<name>Lead generation</name>
				<campaignId>0</campaignId>
				<objectType>
						<objectTypeId>0</objectTypeId>
				</objectType>
		</surveyType>
		<surveyType>
				<surveyTypeId>2</surveyTypeId>
				<name>Matchmaking</name>
				<campaignId>0</campaignId>
				<objectType>
						<objectTypeId>0</objectTypeId>
				</objectType>
				<objectType>
						<objectTypeId>3</objectTypeId>
				</objectType>
		</surveyType>
</surveyTypes>