Skip to content

feat(DCP-2517): add submission request-return command#352

Merged
script-this merged 1 commit intomainfrom
dcp-2517-request-submission-return
Mar 11, 2026
Merged

feat(DCP-2517): add submission request-return command#352
script-this merged 1 commit intomainfrom
dcp-2517-request-submission-return

Conversation

@script-this
Copy link
Copy Markdown
Contributor

@script-this script-this commented Mar 11, 2026 •
edited
Loading

Closes #303

Summary

  • Add prolific submission request-return command to request a participant to return a submission
  • Supports multiple reasons via repeated -r flags (e.g. -r "Didn't finish" -r "Technical problems")
  • Calls POST /api/v1/submissions/{id}/request-return/ with request_return_reasons payload
  • Displays submission ID, status, participant, and return requested timestamp on success

Usage

prolific submission request-return <submission-id> -r "Didn't finish the study"
prolific submission request-return <submission-id> -r "Encountered technical problems" -r "Withdrew consent"

Test plan

  • Unit tests pass (make test) and linter passes (make lint)
  • Command succeeds against API on orange dev environment
    • Single reason: returned timed-out submission successfully
    • Multiple reasons: returned awaiting-review submission successfully
    • No reason flag: error: at least one reason is required
    • Invalid submission ID: API error returned
    • No args: cobra arg validation error

@script-this script-this requested a review from a team as a code owner March 11, 2026 16:08
@prolific-snyk
Copy link
Copy Markdown

prolific-snyk commented Mar 11, 2026 •
edited
Loading

✅ Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@script-this script-this force-pushed the dcp-2517-request-submission-return branch from f525109 to 6f08392 Compare March 11, 2026 16:34
@script-this script-this added team-dct dct-ready-for-review Triggers Slack notification when PR is ready for review labels Mar 11, 2026
@script-this script-this merged commit 07b4b22 into main Mar 11, 2026
7 checks passed
@script-this script-this deleted the dcp-2517-request-submission-return branch March 11, 2026 17:19
@script-this script-this mentioned this pull request Mar 20, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@keyboSlice keyboSlice keyboSlice approved these changes

Assignees

No one assigned

Labels

dct-ready-for-review Triggers Slack notification when PR is ready for review team-dct

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Request participant to return a submission

3 participants

@script-this @prolific-snyk @keyboSlice