Actions

URL fields

From LimeSurvey Manual

Revision as of 12:53, 25 January 2017 by FuzzyBot (talk | contribs) (Importing a new version from external source)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

End URL field

At the end of a survey, or when a quota causes a survey to terminate, there is the option of setting a URL. This URL is presented to the participant who has finished the survey on the completed page, or you can optionally set the participant to be automatically redirected to the URL.

There are a number of fields available to be used to enhance the functionality of this URL.

Basic fields

You can use {SAVEDID}, {TOKEN}, {SID} and {LANG} (since 1.71+) in this URL.

  • SAVEDID is the id assigned to this particular submission,
  • TOKEN is the token used to participate in the survey,
  • SID is the survey ID, and
  • LANG is the language code

Example

http://www.limesurvey.org/test.php?var1={SAVEDID}&var2={TOKEN}&var3={SID}&lang={LANG}

Answer fields

You can also use {INSERTANS:SGQA} in this URL (since 1.82+).

  • {INSERTANS: SGQA} allows adding the response to a specific question in the survey to the final url. This can be useful for sending a response to an external script (ie an email address collected during the survey).

Example

http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7}

Expressions

You can also use any Expression Manager expression (since 1.92+).

Example

http://www.limesurvey.org/test.php?gender={if(sex=='Male','M','F')}&name;={name}

Passthrough fields (LimeSurvey 2.x or later)

Starting with version 2.0 you now have to define any additional parameters that should be passed to the end URL in the survey settings (Tab "Panel integration"). To use such a parameter in the end URL just insert the tag {PASSTHRU:<paramname>} where <paramname> is the name of your input parameter.

Example:

You defined in the Panel integration tab a parameter named 'foobar'. The survey is started with a link like

http://example.org/limesurvey/index.php/survey/index/sid/12345/lang/eb?foobar=XYZ123

where XYZ123 is the value you want to pass.

A survey end URL of http://www.limesurvey.org/test.php?foobarout={PASSTHRU:foobar} would then convert to http://www.limesurvey.org/test.php?foobarout=XYZ123

Passthrough fields (LimeSurvey 1.92 and older)

You can also use a 'passthrough' field name and data value in the end URL.

In some instances you may want to pass a value to the survey at initialization, and then have that value passed through to an external script at the end (for example a marketing firms subsid).

Example

In this case you'd start the survey with the query url "index.php?sid=12345&passthru;=subsid&subsid;=9999".

In your URL you would use {PASSTHRULABEL} and {PASSTHRUVALUE} to reuse these values at the end of the survey.

A URL of "http://www.limesurvey.org/test.php?{PASSTHRULABEL}={PASSTHRUVALUE}" would then convert to "http://www.limesurvey.org/test.php?subsid=9999"

Places to use URL fields

URL fields can be used in the general survey exit URL (see Creating a new survey ), and in the URL setting for each individual quota (see Quotas ).

Start URL

Prefilling a survey using GET parameters

You can prefill all answer except upload and equation question type. You can use qcode naming for the parameters and set the value for single question. For multiple question type, you must use SGQA identifier

Then answer are set to the prefilled value, for single choice option, you must use the code of the answer, for multi choice question, you must use Y if you want to check the answer.

Example

  • http://ls.example.org/1234?QTEXT=prefilled : Fill the question with code Q1 with 'prefilled'
  • http://ls.example.org/1234?1234X1X1SQ001=prefilled : Fill the sub question SQ001 of question number 1 in group 1 with 'prefilled'
  • http://ls.example.org/1234?1234X1X1SQ001=A1 : Check the answer 'A1' at the sub question SQ001 of question number 1 in group 1 .
  • http://ls.example.org/1234?1234X1X1SQ001=Y : Check the sub question SQ001 at question number 1 in group 1.
 Hint: The GET parameters use ? is it the first and & after the first. If you already have ? in your url you must use & to add GET parameters.
 Hint: The extra GET parameters is filled only when survey start. Then, when you make your own test , it's better to add newtest parameters to Y like : http://ls.example.org/1234?QTEXT=prefilled&newtest=Y


Prefilling a survey using GET parameters using URL parameters tab

You can prefill to, sometimes more easily, answer using URL parameters

Prefilling and hidding the answer

You can use hidden avanced settings to hide the question to respondant. Prefilling is happen too.

Before 1.92 version

Before 1.92 version, you must use SGQA and not directly the question code.