...
Specific Requirements
- To register a Team for a Challenge one must (1) be a registered Challenge participant, AND (2) be an administrator (captain) of the Team.
- Provide a service which accepts a user ID and returns a list of teams on whose behalf the user may submit, taking into account any restrictions.
- Send submission receipt notification to all contributors.
- Add an administrative service to add a contributor to a Submission. This allows someone who neglected to sign-up for the challenge but who contributed to a Submission to be given credit by Challenge Administration.
- Defer 'optOut' feature (allowing a user to 'drop off' a submission created by a teammate)
- When retrieving a TeamState, a hash of the object should be returned. The client submits the hash with the Submission and the server throws an exception if the hash is out of date. This ensures that the Team State at the time of submission is the same as that which the user saw.
- Need a service to register a Team based on an Evaluation ID (in contrast to registering based on a Challenge ID).
Submission restriction rule:
Each Submission has a submitter, an optional Team ID and a list of contributors (other user IDs). A submission is accepted if either:
A. It is a valid individual Submission, i.e. (1) it has no Team ID, (2) the submitter hasn't exceeded their per-round submission limit and (2) the submitter is not the submitter of or contributor to a Team Submission (see below) in the current round; OR
B. It is a valid Team Submission, i.e. (1) it has a Team ID of a registered Team, (2) the Team hasn't exceeded its per-round submission limit, (3) all contributors are registered for the challenge and are on the specified Team at the time of submission, and (4) neither the submitter nor any contributor has made an individual Submission or was the submitter of or contributor to a Team Submission having a different Team ID in the current round.
Design Approach
1) A Challenge is a Project with some extra metadata. Implement this as a new object which a Project can 'own', and on which CRUD operations can be done independently from the Project.
...
User registration:
User submission:
All check boxes will not be editable. For an unchecked-disabled Team member, one example reason may be: "This member has exceeded their submission quota. You may ask them to 'opt out' of pending submission(s) by other Team(s) they are on, then retry this submission."
Notes on page 2 (team selection):
- All teams that the current user has admin rights for are shown. On submit, the portal will also attempt to register the selected team to the associated challenge (if it is associated to a challenge).
- There will also be a link to "Create a new Team" which sends the user to the teams section of their profile page.
Opt out:
- user receives submission notification email:
Dear <username>:
We have received a submission to the <challenge name> challenge, created by <other user name>, which includes you as a contributor. This counts towards your quota of <n> submissions for this challenge round. If you feel this is incorrect you may "opt out" of the submission by following this link: http://www.synapse.org:#!Submissions:12345. Otherwise no action is required.
Sincerely,
Synapse Administration
- user following link in email to Portal.
- Portal list submissions for which user may opt out.
Response to User Protests:
* I should have been included in that submission because I'm on the Team that submitted.
* I wasn't able to submit, but I had yet submitted so I wasn't over quota.
Objects
Entity Relationship Diagram
...
Services
Data Transfer Objects
| Class Name | Fields |
|---|---|
| Challenge | id, projectId, participantTeamId, createdBy/On, modifiedBy/On |
| ChallengeTeam | id, challengeId, teamId, message, createdBy/On, modifiedBy/On |
| Submission | ..., contributerIds (array) |
| SubmissionBundle | Submission, SubmissionStatus, TeamState |
| EntityBundle | ..., Challenge |
| URI | Method | Request Parameters | Request Body | Response Body | Authorization | Notes | ||
|---|---|---|---|---|---|---|---|---|
| /challenge | POST | -- | Challenge | Challenge | CREATE permission required in referenced project. | |||
| / | challengeentity/{ | idprojectId}/challenge | GET | -- | -- | Challenge | READ permission required in referenced in project. | |
| /entitychallenge/{projectIdchallengeId}/challenge | GET | -- | -- | Challenge | READ permission required in project. | |||
| /challenge | GET | participantId, limit, offset | -- | ChallengePagedResults | PUBLIC, but to be in the returned list the caller must have READ permission on the project 'owning' the Challenge. | returns the projects/challenges for which 'participantId' is registered. | ||
| /challenge/{idchallengeId} | PUT | -- | Challenge | -- | UPDATE permission required in referenced project. | |||
| /challenge/{idchallengeId} | DELETE | -- | -- | -- | DELETE permission required in referenced project. | |||
| /challenge/{challengeId}/participant | GET | limit, offset, affiliated | PaginatedIds | READ permission required in project. | Return challenge participants. If affiliated=true, return just participants affiliated with some registered Team. If false, return those affiliated with no Team. If missing return all participants. | |||
| /challenge/{idchallengeId}/challengeTeam | POST | -- | ChallengeTeam | ChallengeTeam | Must be a member of the Participant Team and be an admin on the referenced Challenge Team. | |||
| /challenge/{idchallengeId}/challengeTeam/{challTeamId} | GET | -- | -- | ChallengeTeam | Must have READ permission in the Challenge Project. | We defer implementation of this since there is no immediate use case. | ||
| /challenge/{idchallengeId}/challengeTeam | GET | limit, offset, userId | -- | ChallengeTeamPagedResults | Must have READ permission in the Challenge Project. | |||
| /challenge/{challengeId}/registratableTeam | GET | limit, offset | -- | PaginatedList<ChallengeTeam>PaginatedIds | Must have READ permission in the Challenge Project.userId is an | optional filter, limiting the results to just those Teams containing the user. 400 status if not in the Participant TeamReturns the Teams which are NOT registered for the challenge and on which is current user is an ADMIN. | ||
| /challenge/{idchallengeId}/challengeTeam/{challTeamId} | PUT | -- | ChallengeTeam | ChallengeTeam | Must be a member of the Participant Team and be an admin on the referenced Challenge Team. | |||
| /challenge/{id}/challengeTeam/{challTeamId} | DELETE | -- | -- | -- | Must be an admin on the referenced Challenge Team. | |||
| /teamList | POST | IdSet | ListWrapper<Team> | PUBLIC | Returns a list of Teams for a given list of Team IDs. | |||
/team/{id}/memberList | POST | IdSet | ListWrapper<TeamMember> | PUBLIC | Returns the Team Membership info for a given list of memberIds. | |||
| /user/{id}/memberList | POST | IdSet | ListWrapper<TeamMember> | PUBLIC | Returns the user's Membership info for a given list of Teams. | |||
| /challenge/{challengeId}/submissionTeams | GET | principalId, limit, offset | -- | PaginatedIds | Must be the user specified by 'principalId' or be a Synapse Admin | Returns a list of Teams either on whose behalf the user is eligible to submit, i.e. the Teams registered for the challenge and in which the user is a member. | ||
| /evaluation/submission | POST | etag, teamIdsubmissionEligibilityHash | Submission | Submission | Must have SUBMIT permission in the Evaluation referenced in the Submission. | If teamId is included then a TeamState object is created for the Submission. If 'contributer' list is non not empty then teamId is required and Submission is rejected if submitter or any specified contributers is not on the given team. If submissionEligibilityHash is included then teamId must also be included and submission will be rejected if computed TeamSubmissionEligibility does not match hash. Notifications sent to all contributers except for submitter, with instructions for opting out. | ||
| /evaluation/submission/{submissionId}/contributor/{principalId} | POST | -- | -- | Administrative Service | Adds the given user as a contributor to the Submission. | |||
| /evaluation/submission/{idsubmissionId}/optOut | PUT | userId | -- | -- | userId must be the one making the request .(or be a Synapse Administrator) | Sets 'optOut' field for given userId in the Submission. userId must be a contributer in the Submission (not the submitter himself) and Submission must not be in one of the Evaluation's 'optOutDisallowed' states. | ||
| /evaluation/{evaluationId}/team/{id}/submissionEligibility | GET | -- | -- | TeamSubmissionEligibility | user making the request must have SUBMIT permission in the Evaluation and must be a member of the specified Team. |