Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URLHTTP TypeDescription
/competition/{competitionId}/participantPOST

Join as a Participant in a Competition *

/competition/{competitionId}/participant/{principalId}POSTAdd another user as a Participant in a Competition. *
Requires admin rights on the Competition.
/competition/{competitionId}/participant/{principalId}GETGet a Participant
/competition/{competitionId}/participant/{principalId}DELETEDelete a Participant
/competition/{competitionId}/participant/GET

Batch get Participants for a given Competition (Paginated)

Optional request parameters:
limit (long), offset (long)

/competition/{competitionId}/participant/countGETGet the number of Participants in a given Competition

*A Synapse user can only join as a Participant in a Competition if the Competition is OPEN. However, the Competition owner can add other users as Participants at any time, regardless of the Competition state.

Submission

URLHTTP TypeDescription
/competition/submissionPOST

Create a new Submission.
(and corresponding SubmissionStatus object)

/competition/submission/{submissionId}GETGet a Submission
/competition/submission/{submissionId}/statusGET

Get the status of a Submission

/competition/submission/{submissionId}/statusPUT

Update the status of a Submission.
Requires admin rights on the Competition

/competition/submission/{submissionId}DELETEDelete a Submission.
Requires admin rights on the Competition.
/competition/{compId}/submission/GET

Batch get my Submissions for a given Competition (Paginated).
Returns only Submissions owned by the requesting user.

Optional request parameters:
limit (long), offset (long)

/competition/{compId}/submission/allGET

Batch get Submissions for a given Competition (Paginated).
Requires admin rights on the Competition.
Can be filtered by SubmissionStatusEnum.

Optional request parameters:
status (String), limit (long), offset (long)

/competition/{compId}/submission/countGETGet the number of Submissions for a given Competition

...