View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 16809 | Bug reports | Documentation | public | 2020-11-03 14:31 | 2026-11-20 11:57 |
| Reporter | ginosupport | Assigned To | c_schmitz | ||
| Priority | none | Severity | minor | ||
| Status | resolved | Resolution | fixed | ||
| Product Version | 3.x | ||||
| Summary | 16809: RemoteControl API documentation is not clear enough | ||||
| Description | I find the RemoteControl API description unclear. For instance https://api.limesurvey.org/classes/remotecontrol_handle.html#method_add_participants should have a description what the participantdata should look like. The documentation just mentions "The parameters $aParticipantData is a 2 dimensionnal array containing needed participant data.", which in itself is not quite clear enough. The reference to Token helps by showing which fields are available, but it's not good enough if i need to make an API. Please add to the documentation (in this case of Token, but the point holds in general):
Also, the example request has incorrect CSS, the request overflows the box. | ||||
| Tags | No tags attached. | ||||
| Bug heat | 2 | ||||
| Complete LimeSurvey version number (& build) | . | ||||
| I will donate to the project if issue is resolved | |||||
| Browser | . | ||||
| Database type & version | . | ||||
| Server OS (if known) | . | ||||
| Webserver software & version (if known) | . | ||||
| PHP Version | . | ||||
| Git branch / Pull Request URL | . | ||||
|
Fix committed to master branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&id=41369 |
|
|
LimeSurvey: master be754f89 2026-11-20 11:55 Details Diff |
Fixed issue 16809: The RemoteControl API documentation of add_participants and set_participant_properties did not describe the participant fields and their formats, and the example request overflowed its box Dev The documented date format 'YYYY-MM-DD HH:MM:SS' was wrong for sent, remindersent and completed, they hold 'YYYY-MM-DD HH:MM' |
Affected Issues 16809 |
|
| mod - application/helpers/remotecontrol/remotecontrol_handle.php | Diff File | ||
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2020-11-03 14:31 | ginosupport | New Issue | |
| 2026-11-19 22:50 | c_schmitz | Status | new => acknowledged |
| 2026-11-20 10:33 | c_schmitz | Category | Documentation => (No Category) |
| 2026-11-20 11:55 | c_schmitz | Changeset attached | => LimeSurvey master be754f89 |
| 2026-11-20 11:55 | c_schmitz | Note Added: 87811 | |
| 2026-11-20 11:55 | guest | Bug heat | 0 => 2 |
| 2026-11-20 11:57 | c_schmitz | Category | (No Category) => Documentation |
| 2026-11-20 11:57 | c_schmitz | Complete LimeSurvey version number (& build) | => . |
| 2026-11-20 11:57 | c_schmitz | Browser | => . |
| 2026-11-20 11:57 | c_schmitz | Database type & version | => . |
| 2026-11-20 11:57 | c_schmitz | Server OS (if known) | => . |
| 2026-11-20 11:57 | c_schmitz | Webserver software & version (if known) | => . |
| 2026-11-20 11:57 | c_schmitz | PHP Version | => . |
| 2026-11-20 11:57 | c_schmitz | Git branch / Pull Request URL | => . |
| 2026-11-20 11:57 | c_schmitz | Assigned To | => c_schmitz |
| 2026-11-20 11:57 | c_schmitz | Status | acknowledged => resolved |
| 2026-11-20 11:57 | c_schmitz | Resolution | open => fixed |