Skip to navigation

GetAdmissionForm

View as Markdown

Used to get information about the available fields in an admission form

Input Variables

  • formCode: String key of admission form

Return Values

  • json representation of admission form

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.

Response

OK
namestring
notificationReceiverEmailstringformat: "email"
targetstring
typestring
guidstring
periodstring
fieldslist of objects
classeslist of objects
feeslist of objects
coursesanyOptional
levelsAndTagsanyOptional