Translations of this page:
 

API access for personalized participation links

The feature Send InvitationsAPI access allows the following functions:

  • To enter an e-mail addresses or other participant IDs from external software in the address list of the survey project.
  • Optionally, to trigger the sending of individual serial emails, also automated by an external software.
  • To create personalized links to the questionnaire that work just like the personalized links in serial emails.
  • Retrieve the participation status for a serial mail..

An essential application of the API function for serial mails is the connection of a shop system. For example, you can send a valid participation link to the questionnaire to a customer after purchasing the access authorization.

Background

Usually, SoSci Survey creates a personalized URL to participate in a survey in the moment you send a serial mail. Serial numbers can be used to manually create personalized links, but with restrictions on anonymity and functionality - and serial numbers require a different access restriction in the questionnaire than serial emails.

With the Send invitations function → API access you can create personalized links to the questionnaire and, if necessary, use them in external software that works in the same way as the personalized links in serial mail. However, this does not necessarily send an e-mail. If no serial mail is to be sent, not even an e-mail address is necessary.

Create Address Entries

  • First, create a new serial mail under Send invitationsSerial mail. This is not necessarily sent: whether or not can be determined later. But here you can make all settings for the link and check the participation status.
  • Subsequently, then select this serial email under Send invitationsAPI access. Select in Function whether the serial mail should be sent by SoSci Survey or not. If necessary, specify a subgroup for new address entries and, in case of anonymity of new addresses , whether the assignment of person ID (SERIAL) and e-mail address should be possible.
  • Use the Save icon Save to create an API URL.

When calling the API URL, SoSci Survey expects one of the following identification features for the (possibly new) address entry to be transmitted via GET or POST:

  • email e-mail address
  • mobile mobile number for SMS dispatch
  • uid Unique identifier for the addressee

If the API URL is https://www.soscisurvey.de/PROJEKT/?act=83w7vaYqaeakXH7axpH2Yexu , a valid call might look something like this. An identifier (uid, user ID) is used as an identification feature:

  https://www.soscisurvey.de/PROJEKT/?act=83w7vaYqaeakXH7axpH2Yexu&uid=112233aabbcc

If a matching entry is found in the address list, it is used. Otherwise a new entry will be created in Send invitationsAddress list.

SoSci Survey now creates a valid participation link and returns it in response to the call as JSON.

Return Value

The answer to a valid request could look something like this:

{
  "result": "ok",      
  "token":  "QS33T6XMVS4KLA9S",
  "url":    "https:\/\/www.soscisurvey.de\/PROJECT\/?d=QS33T6XMVS4KLA9S",
  "error":  null
}

If successful, the field result contains the value ok, otherwise a different value. In addition, an error message is returned in error. Here, for example, is the answer to a call without an identification feature:

{
  "result": "error", 
  "error":  "Request must specify email, mobile, or uid",  
  "url":    null
}

Manual recall

The API access is designed for an automated call by an external software (machine-to-machine communication), can also be “abused” to create manually valid participation links.

To do this, create an API link as described above. Then call the API URL with different identification features. For example, with the identifiers respondent01, respondent02, respondent03, …

The participant ID must be entered manually in the address line.

  https://www.soscisurvey.de/PROJEKT/?act=83w7vaYqaeakXH7axpH2Yexu&uid=respondent01
  https://www.soscisurvey.de/PROJEKT/?act=83w7vaYqaeakXH7axpH2Yexu&uid=respondent02
  https://www.soscisurvey.de/PROJEKT/?act=83w7vaYqaeakXH7axpH2Yexu&uid=respondent03

Your browser displays a valid participation URL after each call, which can be sent to the participants by e-mail, for example.

A feature to automatically create a larger number of participation links without external software is planned, but currently only with low priority. If anonymity is not critical (or if it is particularly critical), the serial numbers feature can be used.

Participation Status Serial Number

  • Under Send invitationsAPI access at Function, select that you want to query the status of a serial number.
  • With the save icon Save you then create an API URL.

When calling the API URL, SoSci Survey expects a parameter serial to be submitted with the serial number to be checked.

If the API URL is https://www.soscisurvey.de/PROJEKT/?act=exu83w7vaYqaeakXH7axpH2Y, a valid call to check the serial number “CD246802” might look something like the following.

  https://www.soscisurvey.de/PROJEKT/?act=exu83w7vaYqaeakXH7axpH2Y&serial=CD246802

The return value is a JSON string with the following structure:

{
  result:    "ok",
  code:      "CD246802",
  started:   true,
  completed: false,
  notice:    "",
  error:     null
}

The attributes have the following meaning:

  • result – Return value of the request, can take the value “ok” or “error”.
  • code – The queried serial number
  • started – Was the serial number used to start a questionnaire (boolean)
  • completed – If the started questionnaire was filled in to the last page (boolean)
  • notice – A note possibly stored for the serial number
  • error – Error message if result has the value “error
    • “not found” – The serial number searched for is not known in the survey project

In case of an error only the status code and an error message are returned, if available also the requested serial number:

{
  result:    "error",
  error:     "not found",
  code:      "CD246802"
}
en/survey/mailing-api.txt · Last modified: 23.05.2021 16:56 by sophia.schauer
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
Driven by DokuWiki