Skip to navigation

SubmitToAdmissionForm

View as Markdown

Submits application to an admission form

Input Variables

  • formCode: String code of the admission form (path variable)
  • json representation of a Submission Object with the following fields
    • email
    • array of guardians
      • for each guardian an array of fields
    • array of students
      • for each student an array of fields and an array of courses | classes | levels (depending on the form type)

Path parameters

formCodestringRequired

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
createdAtdateRequired
guardianslist of objectsRequired
studentslist of objectsRequired

Response

OK