GetPeriodStudents | DreamClass

curl -G https://api.dreamclass.io/dreamclassapi/v1/students/schoolperiod/2/list \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     --data-urlencode studentId={{studentId}}

[
  {
    "id": 1,
    "active": true,
    "levels": [
      {
        "id": 15,
        "name": "Kindergarten ",
        "institution": {
          "id": 1
        },
        "position": 0,
        "parentLevel": {
          "id": 1
        }
      }
    ],
    "student": {
      "id": 3,
      "email": "test@test.com",
      "birthdate": "2013-12-02T00:00:00.000+00:00",
      "firstname": "Lisa",
      "lastname": "Johnson"
    },
    "addedAt": "2023-10-16T11:25:59.843+00:00",
    "schoolTags": [
      {
        "id": 10,
        "name": "Piano",
        "color": "red-400",
        "institution": {
          "id": 1
        },
        "parentSchoolTag": {
          "id": 9
        },
        "entityType": "STUDENT_TO_SEMESTER"
      },
      {
        "id": 11,
        "name": "Tennis",
        "color": "pink-300",
        "institution": {
          "id": 1
        },
        "parentSchoolTag": {
          "id": 9
        },
        "entityType": "STUDENT_TO_SEMESTER"
      }
    ],
    "studentToClassesCourses": [
      {
        "classesCourse": {
          "id": 54
        }
      },
      {
        "classesCourse": {
          "id": 74
        }
      },
      {
        "classesCourse": {
          "id": 95
        }
      }
    ]
  }
]

Get details of all students of a single period.

Path parameters

schoolPeriodIdstringRequired

Headers

Query parameters

studentIdstringOptional

Id of student (optional)

Response

idinteger

activeboolean

levelslist of objects

studentobject

addedAtdatetime

schoolTagslist of objects

studentToClassesCourseslist of objects