URL fields/nl: Difference between revisions
From LimeSurvey Manual
No edit summary |
(Updating to match new version of source page) |
||
Line 1: | Line 1: | ||
<languages /> | <languages /> | ||
__TOC__ | __TOC__ | ||
=Introduction= | |||
URL fields parameters can be used in the: | |||
* End URL field of the survey (see the [[Survey texts|survey texts wiki section]]); | |||
* URL field of the quota rule (read more about [[Survey quotas|survey quotas here]]) | |||
* Start URL field of the survey. | |||
=Eind-URL veld= | =Eind-URL veld= | ||
At the end of a survey or when a quota causes a survey to terminate, there is the option to set an ending URL. This URL is presented to the participant who has finished the survey on the end page or you can optionally set the participant to be automatically redirected to the respective URL. This can be done by filling in the End URL option from the [[Survey texts]] panel and by enabling the automatic load of the end URL from the [[Presentation]] panel once a survey is completed . | |||
However, there are a number of fields available to be used to enhance the functionality of this URL. | |||
==Basisvelden== | ==Basisvelden== | ||
You can use '''{SAVEDID}''', '''{TOKEN}''', '''{SID}''' and '''{LANG}''' in this URL: | |||
* SAVEDID is | *'''SAVEDID''' is the id assigned to this particular submission; | ||
* TOKEN is | *'''TOKEN''' is the token used to participate in the survey; | ||
* SID is | *'''SID''' is the survey ID; | ||
* LANG is | *'''LANG''' is the language code. | ||
For example: | |||
<code> | <code> | ||
Line 24: | Line 35: | ||
==Antwoordvelden== | ==Antwoordvelden== | ||
You can also use '''{INSERTANS:SGQA}'''. This URL field allows you to add the response to a specific question in the survey into the end URL. This can be useful for sending a response to an external script (ie an email address collected during the survey). | |||
For example: | |||
<code><nowiki> | <code><nowiki> | ||
http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7} | http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7} | ||
</nowiki></code> | </nowiki></code> | ||
==Expressies== | ==Expressies== | ||
You can also use any [[Expression Manager|Expression Manager]] expression here. | |||
For example: | |||
<code><nowiki> | <code><nowiki> | ||
Line 43: | Line 54: | ||
</nowiki></code> | </nowiki></code> | ||
== | ==Passthrough fields== | ||
To use passhtrough fields, you have to define any additional parameters that should be passed into the end URL in the survey settings (read more about the LimeSurvey [[Panel integration|panel integration]] feature). To use such a parameter in the end URL, just insert the tag '''{PASSTHRU:<paramname>}''' where ''<paramname>'' is the name of your input parameter. | |||
Let's suppose that you defined [[Panel integration|a parameter]] named "foobar". The survey is started with a link like | |||
<code> | <code> | ||
Line 55: | Line 64: | ||
</code> | </code> | ||
The XYZ123 is the value you want "to pass". | |||
The end URL of a survey with the following URL <code><nowiki>http://www.limesurvey.org/test.php?foobarout={PASSTHRU:foobar}</nowiki></code> would then be converted to <code><nowiki>http://www.limesurvey.org/test.php?foobarout=XYZ123</nowiki></code> | |||
{{Alert|title=Attention|text=Please note that the passthrough fields can be used only with LimeSurvey 2.x or later!}} | |||
=Start-URL= | |||
==Voorinvullen enquête m.b.v. GET parameters== | ==Voorinvullen enquête m.b.v. GET parameters== | ||
You can prefill all answer except upload and equation question type. You can use [[Expression Manager#Access to Variables|qcode naming]] for the parameters and set the value for single question types. For multiple question type, you must use a [[SGQA identifier]]. | |||
Then answer are set to the pre-filled 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. | |||
''' | Here are some start URL '''examples''': | ||
* <code><nowiki>http://ls.example.org/1234?QTEXT=prefilled</nowiki></code> : Vul de vraag met code Q1 met <nowiki>'prefilled'</nowiki> | * <code><nowiki>http://ls.example.org/1234?QTEXT=prefilled</nowiki></code> : Vul de vraag met code Q1 met <nowiki>'prefilled'</nowiki> | ||
Line 92: | Line 87: | ||
* <code><nowiki>http://ls.example.org/1234?1234X1X1SQ001=Y</nowiki></code> : Controleer de subvraag SQ001 van vraagnummer 1 in groep 1. | * <code><nowiki>http://ls.example.org/1234?1234X1X1SQ001=Y</nowiki></code> : Controleer de subvraag SQ001 van vraagnummer 1 in groep 1. | ||
{{Hint|Text= | {{Hint|Text=GET parameters use "?" for the first parameter and "&" for the subsequent ones. If you already have "?" in your URL, you must use "&" to add more GET parameters.}} | ||
{{Hint|Text= | {{Hint|Text=The extra GET parameters are only filled when the survey starts anew. Therefore, for testing, always add newtest=Y to start a fresh survey. For example: <code><nowiki>http://ls.example.org/1234?QTEXT=prefilled&newtest=Y</nowiki></code>}} | ||
==Voorinvullen enquête m.b.v. GET parameters door gebruik van URL parameters tab== | ==Voorinvullen enquête m.b.v. GET parameters door gebruik van URL parameters tab== | ||
You can prefill (sometimes easier) answers using URL parameters which can be configured in the [[Panel integration|panel integration]]. | |||
== | ==Prefilling and hiding the answer== | ||
You can use hidden advanced settings to hide the question from your respondents. If so, the question still remains prefilled. |
Revision as of 18:25, 25 January 2018
Introduction
URL fields parameters can be used in the:
- End URL field of the survey (see the survey texts wiki section);
- URL field of the quota rule (read more about survey quotas here)
- Start URL field of the survey.
Eind-URL veld
At the end of a survey or when a quota causes a survey to terminate, there is the option to set an ending URL. This URL is presented to the participant who has finished the survey on the end page or you can optionally set the participant to be automatically redirected to the respective URL. This can be done by filling in the End URL option from the Survey texts panel and by enabling the automatic load of the end URL from the Presentation panel once a survey is completed .
However, there are a number of fields available to be used to enhance the functionality of this URL.
Basisvelden
You can use {SAVEDID}, {TOKEN}, {SID} and {LANG} 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;
- LANG is the language code.
For example:
http://www.limesurvey.org/test.php?var1={SAVEDID}&var2={TOKEN}&var3={SID}&lang={LANG}
Antwoordvelden
You can also use {INSERTANS:SGQA}. This URL field allows you to add the response to a specific question in the survey into the end URL. This can be useful for sending a response to an external script (ie an email address collected during the survey).
For example:
http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7}
Expressies
You can also use any Expression Manager expression here.
For example:
http://www.limesurvey.org/test.php?gender={if(sex=='Male','M','F')}&name;={name}
Passthrough fields
To use passhtrough fields, you have to define any additional parameters that should be passed into the end URL in the survey settings (read more about the LimeSurvey panel integration feature). To use such a parameter in the end URL, just insert the tag {PASSTHRU:<paramname>} where <paramname> is the name of your input parameter.
Let's suppose that you defined 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
The XYZ123 is the value you want "to pass".
The end URL of a survey with the following URL http://www.limesurvey.org/test.php?foobarout={PASSTHRU:foobar}
would then be converted to http://www.limesurvey.org/test.php?foobarout=XYZ123
Start-URL
Voorinvullen enquête m.b.v. 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 types. For multiple question type, you must use a SGQA identifier.
Then answer are set to the pre-filled 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.
Here are some start URL examples:
http://ls.example.org/1234?QTEXT=prefilled
: Vul de vraag met code Q1 met 'prefilled'http://ls.example.org/1234?1234X1X1SQ001=prefilled
: Vul de subvraag SQ001 van vraagnummer 1 in groep 1 met 'prefilled'http://ls.example.org/1234?1234X1X1SQ001=A1
: Controleer het antworod 'A1' op de subvraag SQ001 van vraagnummer 1 in groep 1 .http://ls.example.org/1234?1234X1X1SQ001=Y
: Controleer de subvraag SQ001 van vraagnummer 1 in groep 1.
http://ls.example.org/1234?QTEXT=prefilled&newtest=Y
Voorinvullen enquête m.b.v. GET parameters door gebruik van URL parameters tab
You can prefill (sometimes easier) answers using URL parameters which can be configured in the panel integration.
Prefilling and hiding the answer
You can use hidden advanced settings to hide the question from your respondents. If so, the question still remains prefilled.