Differences

This shows you the differences between two versions of the page.

--- en:survey:url [11.09.2019 16:38] – [Selection of a questionnaire (q)] artem.kel
+++ en:survey:url [16.04.2025 01:17] (current) – jacob.wheeler
@@ Line 1: / Line 1: @@
-====== URL to the questionnaire ======
+====== URL to the Questionnaire ======
-Every website needs its URL. So does your questionnaire. To lead questionees to your questionnaire, they will need this adress. This chapter gives tips on how to best use the URL and what possibilities you have.
+Every website needs its URL. So does your questionnaire. To lead questionees to your questionnaire, they will need this address. This chapter gives tips on how to best use the URL and what possibilities you have.
-===== The survey's URL =====
+===== The Survey's URL =====
 The URL of your questionnaire is put together from SoSciSurvey's URL (''%%https://www.soscisurvey.de%%'') and the project directory (e.g. ''demo''). Between those components is a slash (''/''). There is a slash at the end of the address as well, because the address refers to a directory, not a file: ''%%https://www.soscisurvey.de/demo/%%''.
-You will find your survey's URL under **Survey Project** -> **Project Settings** -> Tab //General Settings// -> //Project folder//. There you can also change the project's folder -- but only as long as the //survey adminitsration period// has not started yet. If necessary, you can change the survey period at any time (e.g. set the start of the period to tomorrow's date).
+You will find your survey's URL under **Survey Project** -> **Project Settings** -> Tab //Publish Survey// -> //Questionnaire Hyperlink (URL)//. There you can also change the project's folder -- but only as long as the //survey adminitsration period// has not started yet. If necessary, you can change the survey period at any time (e.g. set the start of the period to tomorrow's date).
 **Note:** If you omit the slash at the end, the participant will still be automatically forwarded to the directory -- you can see that the slash in the address line of the browser is added. This redirection will take a short moment, however.
@@ Line 23: / Line 24: @@
   * [[#selection_of_a_questionnaire_q|Selection of a Questionnaire (q)]] (if several questionnaires were created in the project)
   * [[#marking_a_url_r|Marking a URL (r)]] (Variable REF)
-  * [[#delivering_a_serial_s|Delivering a serial (s)]] (variable SERIAL)
+  * [[#access_code_s|Access Codes (s)]] (variable SERIAL)
   * [[#specify_a_language_l|Specify a language (l)]] (for multilingual survey projects)
   * [[#password_password|Password (password)]] (for a password-protected questionnaire
@@ Line 75: / Line 76: @@
 ===== Selection of a questionnaire (q) =====
-In case you have created more than one questionnaire in your survey project, you can decide, which questionnaire is being shown. You have two options on how to do this (see also: [[:de:create:random_questionnaire|Random Questionnaires]])
+In case you have created more than one questionnaire in your survey project, you can decide, which questionnaire is being shown. This is used whenever the link to the survey project is called without a more detailed specification of a questionnaire. If necessary, you can also include a [[:en:create:random_questionnaire]] in this questionnaire.
+The selection of a questionnaire in the link is done by the parameter ''q'' and the identifier of the desired questionnaire. So to select the questionnaire "fb" in the project "demo" you would send e.g. the following link:
+<code>
+https://www.soscisurvey.de/demo/?q=fb
+</code>
+**Tip:** If you have created several questionnaires in the survey project, you will already find all corresponding //Internet addresses (URLs) for calling up a questionnaire// listed under **Create questionnaire** -> **Manage questionnaires**.
+**Tip:** If you [[:en:survey:mailing]], then set the desired questionnaire directly in the serial mail in the tab //questionnaire link//. The selection of the questionnaire is then stored together with the other settings in the individual participation link.
-  - //Standard questionnaire//: If only one questionnaire (of several created questionnaires) should be shown, you can define the standard questionnaire at **Compose Questionnaire** -> Further Questionnaires -> //Random selection for questionnaires//. Whenever the project directory is called with __no further__ ''q''-parameters, it will open the standard questionnaire.
-  - //Specific selection//: To select a specific questionnaire, use the parameter ''q'' and the questionnaire's ID (Name). To choose the questionnaire "qn" in the project "demo", use: ''%%https://www.soscisurvey.de/demo/?q=qn%%''.
-  - //Random selection//: In case you want SoSciSurvey to choose randomly between several questionnaires, set this at **Compose Questionnaire** -> Further Questionnaires -> //Random selection for questionnaires//. Whenever the project directory is called with __no further__ ''q''-parameters, it will open a randomly chosen questionnaire.
@@ Line 95: / Line 103: @@
-===== Delivering a Serial (s) =====
+===== Access Code (s) =====
-A special case of marking is the serial. This is a one-time-password that allows him to access a questionnaire using [[:de:create:access|Access restrictions]].
+A special case of marking is the access code ([[:en:survey:serials]]). This is a one-time-password that allows him to access a questionnaire using the [[:en:create:access|access restriction]] //Access code//.
-For this to work, every participant needs his valid serial. He doesn't need to type it in by himself -- this is why the serial can be added as the parameter ''s'' to the URL: ''%%https://www.soscisurvey.de/demo/?s=AB123456%%''
+For this to work, every participant needs his valid access code. They don't need to type it in by himself, instead add the access as the parameter ''s'' to the URL: ''%%https://www.soscisurvey.de/demo/?s=AB123456%%''
-**Tip:** When sending personalized URLs using serials, participants are able to interrupt the interview and resume it later where they left off. This even works for questionnaires that are basically public. Nevertheless, every participant needs to have his own serial beforehand.
+Access codes must only contain letters (A-Z) and digits (0-9).
-**Important:** An individual serial is only valid until exactly one questionnaire is completed. Afterwards, the serial is used up.
+**Tip:** When sending personalized URLs using access codes, participants are able to pause the interview and resume it later where they left off. This even works for questionnaires that are public. Nevertheless, every participant needs to have their own access code beforehand.
-**Important:** An individual serial is only valid until the questionnaire was completed (to the last page) once. For details see [[:en:survey:mailing#serial_numbers|Serial Numbers]].
+**Important:** An individual access code is only valid until the questionnaire was filled out and reached the last page. Afterwards, the access code won't work, any more. For more details see [[::/en:survey: serials]].
-===== Participation code serial mail (d) =====
-If sending a serial mail using SoSciSurvey and using the placeholder ''%link%'' for personalized links, SoSciSurvey will attach the parameter ''d'' (delivery ID).
-This is a software-internal code that is being recreated for every serial mail and every participant. So the parameter ''d'' should be left to the software and should not be used by yourself.
 ===== Specify a language (l) =====
@@ Line 124: / Line 128: @@
 In case you have secured your questionnaire by passwords, you can deliver those in the link. The parameter is ''password''. If the password was "secret123", the following link would give access to the questionnaire: ''%%https://www.soscisurvey.de/demo/?password=secret123%%''.
-However, it is not reasonable to post a link containing a password publicly on a webpage. This makes the password protection useless. Using this parameter is more useful when inviting participants via email. But the more secure way is using the serial mail or the serial number (because those are one-time only).
+However, it is not reasonable to post a link containing a password publicly on a webpage. This makes the password protection useless. Using this parameter is more useful when inviting participants via email. But the more secure way is using the serial mail or the access code (because those are one-time only).
-===== Variing the pretest-mode (debug) =====
-When a questionnaire is in pretest, the participants can receive a particular pretest-version with a feedback option or the original questionnaire. The first one is standard when your survey is in pretest. Stating the parameter ''debug'' (with no value this time), will call for the original version: ''%%https://www.soscisurvey.de/demo/?debug%%''.
-If you want to lead pretesters to the original version without them having to type a password, you can combine the parameters ''debug'' and ''password'': ''%%https://www.soscisurvey.de/demo/?debug&password=secret123%%''.
@@ Line 141: / Line 140: @@
-===== User defined variables =====
+===== Participation Code Serial Mail (d) =====
+If sending a mailing via SoSciSurvey and using the placeholder ''%link%'' for personalized links, SoSciSurvey will attach the parameter ''d'' (delivery ID).
+This is a software-internal code that is being recreated for every mailing and every participant. So the parameter ''d'' should be left to the software and should not be used by yourself.
+===== Custom Variables =====
-Using the PHP-function ''[[:en:create:functions:readget#readget|readGET()]]'' allows you to call user defined variables from the questionnaire's URL.
+Using the question type ''[[:en:create:questions:client]]'' or the PHP function ''[[:en:create:functions:readget#readget|readGET()]]'' allows you to read user defined variables from the request URL.
-You should not use the above variables (''q'', ''r'', ''s'', ''d'', ''l'', ''password'', ''debug'') as well as the following: ''a'', ''act'', ''adid'', ''ajax'', ''file'', ''image'', ''info'', ''script'', ''sp'', ''t''
+In addition to the variables listed above (''q'', ''r'', ''s'', ''d'', ''i'', ''l'', ''password''), the following reserved variables should not be used to pass user-defined data: ''a'', ''act'', ''adid'', ''ajax'', ''debug'', ''file'', ''image'', ''info'', ''library'', ''script'', ''sp'', ''t''
 To ensure your user defined variables won't collide with standard variables, choose a name starting with ''u''. Those are explicitly reserved for user defined variables.