x

Main chapters

  1. LimeSurvey Cloud vs LimeSurvey CE
  2. LimeSurvey Cloud - Quick start guide
  3. LimeSurvey CE - Installation
  4. How to design a good survey (Guide)
  5. Getting started
  6. LimeSurvey configuration
  7. Introduction - Surveys
  8. View survey settings
  9. View survey menu
  10. View survey structure
  11. Introduction - Questions
  12. Introduction - Question Groups
  13. Introduction - Surveys - Management
  14. Survey toolbar options
  15. Multilingual survey
  16. Quick start guide - ExpressionScript
  17. Advanced features
  18. General FAQ
  19. Troubleshooting
  20. Workarounds
  21. License
  22. Version change log
  23. Plugins - Advanced
 Actions

REST API: Difference between revisions

From LimeSurvey Manual

Kfoster (talk | contribs)
No edit summary
Kfoster (talk | contribs)
Replaced content with "; TODO - Under development : Available from version x (Version to be defined)"
Tag: Replaced
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
TODO
; TODO - Under development
 
: Available from version x (Version to be defined)
Under development
 
Available from version x (LS 5.5.0?)
 
Available API endpoints
 
Technical specification. UML.
 
=Introduction=
 
LimeSurvey REST API v1 is available in LS 5.5.0 or more recent which offers '''various [https://api.limesurvey.org/swagger API endpoints]'''.
 
=Setup=
 
==Configure==
 
In order to use REST API you must first enable the service, and then adjust the settings to suit your needs. To enable login to the LimeSurvey administration, go to [[Global settings]], choose the tab 'Interfaces' and select 'Publish API on /rest'.
 
==Security==
 
The REST API uses the same security measures as the normal administration login. That means that the permission set of the used username and password is the same as if you would login in the administration with that user/password. Also the REST API is protected against brute-force password cracking - like the normal administration login.
 
=Usage=
==API Location==
 
The REST API URL is [http://www.yourdomain.com/rest/v1 http://www.yourdomain.com/rest/v1] .
 
The available API endpoints are documented using swagger [https://api.limesurvey.org/swagger https://api.limesurvey.org/swagger].
 
==Sessions==
 
==Endpoints==
 
See the  [https://api.limesurvey.org/swagger Swagger Documentation] for full details.
 
; /rest/v1/
: session
: session
: siteSettings
: siteSettings/<setting-name>
: survey
: survey/<id>
: questionGroup/<surveyId>
: questionGroup
: questionGroup/<groupId>
: questionGroupProperties/<groupId>
: questioGroupProperties/<groupId>
 
=Examples=
 
==PHP Example==

Latest revision as of 17:40, 30 October 2023

TODO - Under development
Available from version x (Version to be defined)