Skip to content
API documentation

Changelog

Version 1.3.0

A group challenge can ask every member of a group for a signed parental consent form. Reading a group counts the forms that are in, and sending the work waits until every active member's is. Groups of a challenge that does not ask for consent are answered as in 1.2.0.

Added

  • Parental consent on group challenges. A challenge can ask every member of a group for a signed parental consent form, which each member uploads in the panel or the app. getGroupChallengeGroup gains consent ({ required, received, memberCount }, counted over the group's active members, or null when the challenge does not ask for consent) and, on each of yourStudents, consentReceived (true, false, or null when not asked). canFinalSubmit is false until every active member's form is in. The forms themselves are never shown.
  • submitGroupChallengeWork answers 409 conflict with the new details.reason consent_missing, with consentsReceived and memberCount in details, when the challenge asks for parental consent and an active member's form is not in yet. It is checked after every other refusal, and a group whose work was already sent still answers 200 with changed: false. Groups of a challenge that does not ask for consent are answered exactly as before.

Release notes

Version 1.3.0 adds two response fields and one refusal reason, and removes nothing. Code written against 1.2.0 keeps working without a change on every challenge that does not ask for parental consent.

An organization can ask every member of a group for a signed parental consent form. Each member downloads the challenge's blank form in the panel or the app, has it signed, and uploads it there. This API never uploads, shows or downloads a form: it counts them.

  • getGroupChallengeGroup gains consent, { "required": true, "received": 2, "memberCount": 3 }, counted over the group's active members, and consentReceived on each of yourStudents. Both are null when the challenge does not ask for consent.
  • canFinalSubmit is false until every active member's form is in.
  • submitGroupChallengeWork answers 409 conflict with details.reason: consent_missing, and consentsReceived and memberCount in details, until then. Steps can still be submitted without the forms.

See Parental consent.

Errors

consent_missing is a new value of error.details.reason on the 409 conflict of submitGroupChallengeWork. As with the other reasons, it waits on the group's members: don't retry it in a loop. If your code treats an unknown reason as "not ready yet", it already handles it. See conflict.

Search the API documentation

Guides, endpoints by name, path or permission, and error codes such as not_found.