getQuestionnaireDefinition

This method retrieves the questionnaire definition data.

Object: /net/dsb/avs3/Questionnaire
Method: getQuestionnaireDefinition
Version: 2.0.0
Fuba: /DSB/ISM_E_GET_QUESTIONAIRE

Parameter

Name	Type / max. length	mandatory?	Description
questionnaire-id	AN / 10	m	Questionnaire ID

Response Element

XML structur ‚questionnaire-definition‘

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="avs/3" >
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <questionnaire-definition>
      <questionnaire-id></questionnaire-id>
    </questionnaire-definition>
  </body>
</message>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="avs/3">
  <header>
    <client>999</client>
    <avs3-sales-organization>9999</avs3-sales-organization>
    <avs3-service-provider>123</avs3-service-provider>
  </header>
  <body>
    <questionnaire-definition>
  ...
  </questionnaire-definition>
  </body>
</message>

Response Structure

Structure <questionnaire-definition>

<questionnaire-definition>
  <questionnaire-id></questionnaire-id>
  <sales-organization></sales-organization>
  <distribution-channel></distribution-channel>
  <division></division>
  <questionnaire-code></questionnaire-code>
  <questionnaire-description></questionnaire-description>
  <publication></publication>
  <edition></edition>
  <mix-type></mix-type>
  <purchase-frequency></purchase-frequency>
  <questionnaire-valid></questionnaire-valid>
  <create-vtl></create-vtl>
  <strict-check></strict-check>
  <create-on-qualification-criteria></create-on-qualification-criteria>
  <campaign>
    <questionnaire-campaign-id></questionnaire-campaign-id>
    <questionnaire-campaign-text></questionnaire-campaign-text>
    <questionnaire-signature-type></questionnaire-signature-type>
    <questionnaire-submit-type></questionnaire-submit-type>
    <questionnaire-source></questionnaire-source>
    <questionnaire-origin></questionnaire-external-origin>
    <archiv-type></archiv-type>
    <is-questionnaire-campaign-deleted></is-questionnaire-campaign-deleted>
    <questionnaire-signed></questionnaire-signed>
    <questionnaire-aggreement></questionnaire-aggreement>
    <vtl-valid-duration-in-months></vtl-valid-duration-in-months>
    <vtl-delivery-quantity></vtl-delivery-quantity>
  </campaign>
  <!—1 … n -->
  <question>
    <question-id></question-id>
    <question-nr></question-nr>
    <question-type></question-type>
    <question-text></question-text>
    <is-question-mandatory></is-question-mandatory>
    <!—1 … n -->
    <answer>
      <answer-id></answer-id>
      <answer-nr></answer-nr>
      <answer-code></answer-code>
      <answer-type></answer-type>
      <answer-reference></answer-reference>
      <answer-description></answer-description>
    </answer>
  </question>
</questionnaire-definition>

Element Definitions

Field	Length	Type	Remark, field supply or encoding
questionnaire-id	10	AN	Questionnaire ID
sales-organization	4	AN	sales organization
distribution-channel	2	AN	distribution channel
division	2	AN	division
questionnaire-code	20	AN	Questionnaire code
questionnaire-description	132	AN	Questionnaire description
publication	8	AN	publication
edition	8	AN	edition
mix-type	2	AN	mix-type
purchase-frequency	5	AN	purchase frequency
questionnaire-valid		B	Is questionnaire valid? true / false
create-vtl	2	AN	Determines if a VTL record will be generated additionally during the creation of a questionnaire responder 01 = Do not set up 04 = auto. always set up 05 = auto. always set up and display 06 = auto. always set up and change
strict-check		B	Indicates if specific fields need to be entered to create a questionnaire responder. true / false
create-on-qualification-criteria	2	AN	Determines if a non-qualified responder might be created or not or with a warning message. 01 = always set up 02 = warning if not qualified 03 = prevent if not qualified
campaign 0 … n
questionnaire-campaign-id	10	AN	Campaign ID
questionnaire-campaign-text	132	AN	Campaign Description
questionnaire-signature-type	2	AN	Type of Signature
questionnaire-submit-type	2	AN	Type of Submission
questionnaire-source	2	AN	Source
questionnaire-origin	2	AN	Data Origin
archiv-type	2	AN	Archive Type
is-questionnaire-campaign-deleted		B	true / false
questionnaire-signed	1	AN	Questionnaire: Is Questionnaire Signed? Y / N
questionnaire-aggreement	1	AN	Questionnaire: Agreement for free Subscription? Y / N
vtl-valid-duration-in-months	2	AN	Valid duration in month
vtl-delivery-quantity		AN	Quantity
question 1 … n
* question-id	3	AN	question ID
* question-nr	5	AN	question number
* question-type	2	AN	question Code
* question-text	132	AN	question text
* is-question-mandatory	1	AN	Question required? Y / N
answer 1 … n
* answer-id		AN	answer ID
* answer-nr		AN	answer number
* answer-code		AN	answer code
* answer-type		AN	answer type
* answer-reference		AN	answer reference
* answer-description		AN	answer description