GetAdmissionForm | DreamClass

{
  "name": "form1",
  "notificationReceiverEmail": "admin@test.com",
  "target": "GUARDIAN",
  "type": "APPLICATION",
  "guid": "ABCDEF",
  "period": "2023",
  "fields": [
    {
      "name": "name",
      "label": "Name",
      "type": "textarea",
      "entity": "STU",
      "required": true,
      "values": "Any valid string"
    },
    {
      "name": "extra",
      "label": "Need extra items?",
      "type": "dynamic-select",
      "entity": "GUA",
      "required": true,
      "values": "1 (Yes)|2 (No)"
    }
  ],
  "classes": [
    {
      "id": 1,
      "name": "1st Grade"
    }
  ],
  "fees": [
    {
      "id": 1,
      "name": "Test Fee",
      "amount": 100
    }
  ]
}

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

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

Response

namestring

notificationReceiverEmailstringformat: "email"

targetstring

typestring

guidstring

periodstring

fieldslist of objects

classeslist of objects

feeslist of objects

coursesanyOptional

levelsAndTagsanyOptional