Welcome to the LimeSurvey Community Forum

Ask the community, share ideas, and connect with other LimeSurvey users!

RemoteControl API

  • labean0103
  • labean0103's Avatar Topic Author
  • Offline
  • New Member
  • New Member
More
2 years 1 week ago #236332 by labean0103
RemoteControl API was created by labean0103
LimeSurvey version: 3.25.18+210316
==================
Hey!

This might sounds like a stupid question, but I need some help. I am reading about LimeSurvey RemoteControl API and how to use it, but I still don't quite understand how to integrate the API into LimeSurvey surveys. Could someone explain to me in a simple way, how to start using the LSRC API? The only thing I understand perfectly, is that I have to configure it to JSON/XML RPC and then I have no idea how to start using it. I've read the whole manual for LSRC but still, I am quite confused about how to start implementing it into the surveys. I did not download LimeSurvey and I'm one of the users of our LimeSurvey system. Do I have to use some external software to start using the API? Where should I code the methods? I've been trying to find some tutorials, but didn't find anything on YouTube either. Any help would be appreciated, thank you.

Please Log in to join the conversation.

  • holch
  • holch's Avatar
  • Away
  • LimeSurvey Community Team
  • LimeSurvey Community Team
More
2 years 1 week ago #236342 by holch
Replied by holch on topic RemoteControl API
In order to use the API you will have to create your own script somewhere.

I answer at the LimeSurvey forum in my spare time, I'm not a LimeSurvey GmbH employee.
No support via private message.

Please Log in to join the conversation.

  • labean0103
  • labean0103's Avatar Topic Author
  • Offline
  • New Member
  • New Member
More
2 years 1 week ago #236347 by labean0103
Replied by labean0103 on topic RemoteControl API
Okay, thanks, but do I create that script outside of LimeSurvey and then somehow put it there?

Please Log in to join the conversation.

More
2 years 1 week ago #236355 by bismark
Replied by bismark on topic RemoteControl API
can you describe a specific use case?

Please Log in to join the conversation.

  • labean0103
  • labean0103's Avatar Topic Author
  • Offline
  • New Member
  • New Member
More
2 years 1 week ago #236356 by labean0103
Replied by labean0103 on topic RemoteControl API
Well, I posted my question explaining my case yesterday, and I actually got an answer from you too, bismark!
forums.limesurvey.org/forum/can-i-do-thi...icipants-to-a-survey

I just still can't get my head around implementing API into LimeSurvey since I have never had to download the actual LimeSurvey and I'm just one of the users on a LS website. I know how to use usual open APIs but this time I'm really confused on where do I have to call this RemoteControl API, where should I code all that. Sorry, if this is a dumb question, I'm just really confused :')

Please Log in to join the conversation.

  • tpartner
  • tpartner's Avatar
  • Offline
  • LimeSurvey Community Team
  • LimeSurvey Community Team
More
2 years 1 week ago #236357 by tpartner
Replied by tpartner on topic RemoteControl API
The API is not primarily for use within LimeSurvey. It is normally used in external PHP (or other supported languages) files to externally manipulate LimeSurvey.

In your use case - creating tokens for another survey from within a survey - you will need to create the external (PHP?) file somewhere on your server and then access it via an AJAX call from the survey.

Cheers,
Tony Partner

Solutions, code and workarounds presented in these forums are given without any warranty, implied or otherwise.
The following user(s) said Thank You: labean0103

Please Log in to join the conversation.

  • labean0103
  • labean0103's Avatar Topic Author
  • Offline
  • New Member
  • New Member
More
2 years 1 week ago #236358 by labean0103
Replied by labean0103 on topic RemoteControl API
Okay, I see! Thank you for the explanation

Please Log in to join the conversation.

More
2 years 1 week ago #236361 by bismark
Replied by bismark on topic RemoteControl API
you can start here: www.limesurvey.org/manual/RemoteControl_2_API#PHP_Example

just copy/paste the code and replace user credentials, execute the script and see what happens

all API functions you can find here: api.limesurvey.org/classes/remotecontrol_handle.html
The following user(s) said Thank You: labean0103

Please Log in to join the conversation.

  • labean0103
  • labean0103's Avatar Topic Author
  • Offline
  • New Member
  • New Member
More
2 years 6 days ago #236365 by labean0103
Replied by labean0103 on topic RemoteControl API
Okay! Thanks a lot.

Please Log in to join the conversation.

  • tpartner
  • tpartner's Avatar
  • Offline
  • LimeSurvey Community Team
  • LimeSurvey Community Team
More
2 years 6 days ago #236369 by tpartner
Replied by tpartner on topic RemoteControl API
Here is a working example - forums.limesurvey.org/forum/development/...-custom-token#193943

You will probably want to remove the check for an existing token and change the $bCreateToken parameter to true;

Cheers,
Tony Partner

Solutions, code and workarounds presented in these forums are given without any warranty, implied or otherwise.

Please Log in to join the conversation.

Moderators: holchtpartner

Lime-years ahead

Online-surveys for every purse and purpose