> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc.dreamclass.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server. # GetPeriodStudents GET https://dreamclassapi/v1/students/schoolperiod/2/list Get details of all students of a single period. See also GetPeriodClassCourses Input variables - schoolPeriodId: id of the School Period Reference: https://apidoc.dreamclass.io/dream-class-api/students/get-period-students ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /dreamclassapi/v1/students/schoolperiod/2/list: get: operationId: get-period-students summary: GetPeriodStudents description: |- Get details of all students of a single period. See also GetPeriodClassCourses Input variables - schoolPeriodId: id of the School Period tags: - subpackage_students parameters: - name: studentId in: query description: |+ Id of student (optional) required: false schema: type: string - name: tenant in: header required: false schema: type: string - name: schoolCode in: header required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: {} servers: - url: https:/ description: https://{server} - url: https://your-webhook-url description: https://your-webhook-url ``` ## Examples **Response** ```json "[\r\n {\r\n \"id\": 1,\r\n \"active\": true,\r\n \"levels\": [\r\n {\r\n \"id\": 15,\r\n \"name\": \"Kindergarten \",\r\n \"code\": null,\r\n \"color\": null,\r\n \"institution\": {\r\n \"id\": 1\r\n },\r\n \"alt\": null,\r\n \"position\": 0,\r\n \"parentLevel\": {\r\n \"id\": 1\r\n },\r\n \"children\": null,\r\n \"studentSemesterInfos\": null\r\n }\r\n ],\r\n \"student\": {\r\n \"id\": 3,\r\n \"email\": \"test@test.com\",\r\n \"birthdate\": \"2013-12-02T00:00:00.000+00:00\",\r\n \"firstname\": \"Lisa,\r\n \"lastname\": \"Johnson\"\r\n },\r\n \"addedAt\": \"2023-10-16T11:25:59.843+00:00\",\r\n \"schoolTags\": [\r\n {\r\n \"id\": 10,\r\n \"name\": \"Piano\",\r\n \"code\": null,\r\n \"color\": \"red-400\",\r\n \"institution\": {\r\n \"id\": 1\r\n },\r\n \"clazzes\": null,\r\n \"dcFiles\": null,\r\n \"studentSemsterInfos\": null,\r\n \"professorSemsterInfos\": null,\r\n \"noteClassCourses\": null,\r\n \"notes\": null,\r\n \"parentSchoolTag\": {\r\n \"id\": 9\r\n },\r\n \"entityType\": \"STUDENT_TO_SEMESTER\",\r\n \"position\": null\r\n },\r\n {\r\n \"id\": 11,\r\n \"name\": \"Tennis\",\r\n \"code\": null,\r\n \"color\": \"pink-300\",\r\n \"institution\": {\r\n \"id\": 1\r\n },\r\n \"clazzes\": null,\r\n \"dcFiles\": null,\r\n \"studentSemsterInfos\": null,\r\n \"professorSemsterInfos\": null,\r\n \"noteClassCourses\": null,\r\n \"notes\": null,\r\n \"parentSchoolTag\": {\r\n \"id\": 9\r\n },\r\n \"entityType\": \"STUDENT_TO_SEMESTER\",\r\n \"position\": null\r\n }\r\n ],\r\n \"studentToClassesCourses\": [\r\n {\r\n \"classesCourse\": {\r\n \"id\": 54\r\n }\r\n },\r\n {\r\n \"classesCourse\": {\r\n \"id\": 74\r\n }\r\n },\r\n {\r\n \"classesCourse\": {\r\n \"id\": 95\r\n }\r\n }\r\n ]\r\n }\r\n \r\n]" ``` **SDK Code** ```python Students_GetPeriodStudents_example import requests url = "https://https/dreamclassapi/v1/students/schoolperiod/2/list" querystring = {"studentId":"{{studentId}}"} headers = { "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}" } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Students_GetPeriodStudents_example const url = 'https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D'; const options = {method: 'GET', headers: {tenant: '{{tenant}}', schoolCode: '{{schoolCode}}'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Students_GetPeriodStudents_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("tenant", "{{tenant}}") req.Header.Add("schoolCode", "{{schoolCode}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Students_GetPeriodStudents_example require 'uri' require 'net/http' url = URI("https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["tenant"] = '{{tenant}}' request["schoolCode"] = '{{schoolCode}}' response = http.request(request) puts response.read_body ``` ```java Students_GetPeriodStudents_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D") .header("tenant", "{{tenant}}") .header("schoolCode", "{{schoolCode}}") .asString(); ``` ```php Students_GetPeriodStudents_example request('GET', 'https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D', [ 'headers' => [ 'schoolCode' => '{{schoolCode}}', 'tenant' => '{{tenant}}', ], ]); echo $response->getBody(); ``` ```csharp Students_GetPeriodStudents_example using RestSharp; var client = new RestClient("https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D"); var request = new RestRequest(Method.GET); request.AddHeader("tenant", "{{tenant}}"); request.AddHeader("schoolCode", "{{schoolCode}}"); IRestResponse response = client.Execute(request); ``` ```swift Students_GetPeriodStudents_example import Foundation let headers = [ "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}" ] let request = NSMutableURLRequest(url: NSURL(string: "https://https/dreamclassapi/v1/students/schoolperiod/2/list?studentId=%7B%7BstudentId%7D%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```