This is the version 1.0 of the public DreamClass API.
\nIt includes REST operations for managing numerous items in your DreamClass platform, such as Admissions, Invoices, Students, and Events. There’s also a collection of webhooks available to allow you to listen for changes within the platform as well.
\nImportant Notices
\nFor security reasons, you must contact support@dreamclass.io to request API activation for your account. This will then allow you to access and manage your DreamClass API key and school code.
\nHow to send an authorized request
\nTo make an authorized request, you will need three pieces of information:
\nyour API key
\nyour school code
\nyour tenant code
\nOnce DreamClass tech team enables your API access you can access your API key and school code in your DreamClass settings:
\n![](\"https://lh7-rt.googleusercontent.com/docsz/AD_4nXeIukeYTIYg2dV2_7C03dP1tAb8jDspNr9-t4YYsKjnZlG0uRARjwOPWtgN71Bv75FriuBsgVNO9SvFa5tTXoxapX_UDQ5GKckeZxq_Rv8x0uAQDuAU0KVy2R5q0oLYOCDHvMvT6Q?key=GXMX7mYiZhvQlz7VlR22DQ\")
\n\nYour tenant code will be your DreamClass account subdomain, so if you access your DreamClass via https://myaccount.dreamclass.io then your tenant code is “myaccount”. However if you have a whitelabeled domain set up then your tenant code will be your full domain that you DreamClass account is whitelabeled to, so if you setup your domain to be https://portal.mywebsite.com then your tenant code is “portal.mywebsite.com”.
\nAll API requests are sent to the same endpoint, so when reading these docs {{server}} should always be https://api.dreamclass.io.
\nWhen making the request, be sure to use API Key as the Auth Type, and configure it like so:
\nkey | dreamclass-secret-key
value | {{yourApiKey}}
location | Header
In the Headers of your request, you will also need to include the following items:
\nschoolCode | {{schoolCode}}
tenant | {{tenant}}
Used to get information about the available fileds in an admission form
\nInput Variables
\nReturn Values
\nUsed to get information about the available fileds in an admission form
\nInput Variables
\nReturn Values
\nSubmits application to an admission form
\nInput Variables
\nGet the list of attendance statuses
\n","urlObject":{"path":["dreamclassapi","v1","students","attendance","status","list"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"ef3fd9f3-7671-4f4f-a40c-609eaacb9159","name":"GetAttendanceStatuses","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/attendance/status/list"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n \"PRESENT\",\r\n \"UNEXCUSED\",\r\n \"EXCUSED\",\r\n \"EXPELLED\",\r\n \"TARDY\"\r\n]"}],"_postman_id":"2f4594d1-f13e-4a9d-91bd-9e397ffa28aa"},{"name":"GetLessonAttendance","id":"f41cf84b-3169-4875-b9e1-8fcc11e6fe8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/attendance/lesson/list?periodId={{periodId}}&fromDate={{fromDate}}&toDate={{toDate}}&statuses={{statuses}}&studentId ={{studentId}}&classId={{classId}}&courseId={{courseId}}","description":"Get a list of lesson attendances for the given parameters.
\nUsed for classes that are set with Lesson Attendance mode
\n","urlObject":{"path":["dreamclassapi","v1","students","attendance","lesson","list"],"host":["{{server}}"],"query":[{"key":"periodId","value":"{{periodId}}"},{"description":{"content":"Start date of attendances e.g. 2024-12-31 ISO format
\n","type":"text/plain"},"key":"fromDate","value":"{{fromDate}}"},{"description":{"content":"End date of attendances e.g. 2025-01-25 ISO format
\n","type":"text/plain"},"key":"toDate","value":"{{toDate}}"},{"description":{"content":"List of attendance statuses (comma separated)
\n","type":"text/plain"},"key":"statuses","value":"{{statuses}}"},{"description":{"content":"Id of student (optional)
\n","type":"text/plain"},"key":"studentId ","value":"{{studentId}}"},{"description":{"content":"Id of class (optional)
\n","type":"text/plain"},"key":"classId","value":"{{classId}}"},{"description":{"content":"Id of course (optional, mandatory set classId)
\n","type":"text/plain"},"key":"courseId","value":"{{courseId}}"}],"variable":[]}},"response":[{"id":"4d902fb2-27b4-45d7-a03d-d4c74c908989","name":"GetLessonAttendance","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/students/attendance/lesson/list?periodId={{periodId}}&fromDate={{fromDate}}&toDate={{toDate}}&statuses={{statuses}}&studentId ={{studentId}}&classId={{classId}}&courseId={{courseId}}","host":["{{server}}"],"path":["dreamclassapi","v1","students","attendance","lesson","list"],"query":[{"key":"periodId","value":"{{periodId}}"},{"key":"fromDate","value":"{{fromDate}}"},{"key":"toDate","value":"{{toDate}}"},{"key":"statuses","value":"{{statuses}}","description":"List of attendance statuses (comma separated)"},{"key":"studentId ","value":"{{studentId}}","description":"Id of student (optional)"},{"key":"classId","value":"{{classId}}","description":"Id of class (optional)"},{"key":"courseId","value":"{{courseId}}","description":"Id of course (optional, mandatory set classId)"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"studentId\": 3,\r\n \"attendanceStatus\": \"PRESENT\",\r\n \"date\": \"2024-02-12T08:00:00\",\r\n \"comments\": null,\r\n \"classId\": 31,\r\n \"courseId\": 48,\r\n \"minutesLate\": null,\r\n \"attendancePoints\": null\r\n },\r\n {\r\n \"studentId\": 23,\r\n \"attendanceStatus\": \"PRESENT\",\r\n \"date\": \"2024-02-12T08:00:00\",\r\n \"comments\": null,\r\n \"classId\": 31,\r\n \"courseId\": 48,\r\n \"minutesLate\": null,\r\n \"attendancePoints\": null\r\n } \r\n]"}],"_postman_id":"f41cf84b-3169-4875-b9e1-8fcc11e6fe8c"},{"name":"GetDailyAttendance","id":"b99b18da-a329-4b23-8f64-e07bf03a73e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/attendance/daily/list?periodId={{periodId}}&fromDate={{fromDate}}&toDate={{toDate}}&statuses={{statuses}}&studentId ={{studentId}}","description":"Get a list of daily attendances for the given parameters.
\nUsed for classes that are set with Daily Attendance mode
\n","urlObject":{"path":["dreamclassapi","v1","students","attendance","daily","list"],"host":["{{server}}"],"query":[{"key":"periodId","value":"{{periodId}}"},{"description":{"content":"Start date of attendances e.g. 2024-12-31 ISO format
\n","type":"text/plain"},"key":"fromDate","value":"{{fromDate}}"},{"description":{"content":"End date of attendances e.g. 2025-01-25 ISO format
\n","type":"text/plain"},"key":"toDate","value":"{{toDate}}"},{"key":"statuses","value":"{{statuses}}"},{"key":"studentId ","value":"{{studentId}}"}],"variable":[]}},"response":[{"id":"3935d9ad-2da1-4769-b164-9538da1e8345","name":"GetDailyAttendance","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/students/attendance/daily/list?periodId={{periodId}}&fromDate={{fromDate}}&toDate={{toDate}}&statuses={{statuses}}&studentId ={{studentId}}","host":["{{server}}"],"path":["dreamclassapi","v1","students","attendance","daily","list"],"query":[{"key":"periodId","value":"{{periodId}}"},{"key":"fromDate","value":"{{fromDate}}","description":"2024-12-31"},{"key":"toDate","value":"{{toDate}}","description":"2025-01-25"},{"key":"statuses","value":"{{statuses}}"},{"key":"studentId ","value":"{{studentId}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"studentId\": 3,\r\n \"attendanceStatus\": \"PRESENT\",\r\n \"date\": \"2023-12-13\",\r\n \"comments\": null,\r\n \"checkIn\": null,\r\n \"checkOut\": null\r\n },\r\n {\r\n \"studentId\": 3,\r\n \"attendanceStatus\": \"PRESENT\",\r\n \"date\": \"2024-02-12\",\r\n \"comments\": null,\r\n \"checkIn\": null,\r\n \"checkOut\": null\r\n }, \r\n]"}],"_postman_id":"b99b18da-a329-4b23-8f64-e07bf03a73e6"}],"id":"dcc92bf7-7d0d-439d-8b75-1cb91894495b","_postman_id":"dcc92bf7-7d0d-439d-8b75-1cb91894495b","description":""},{"name":"Calendar","item":[{"name":"GetSingleEvent","id":"d412b26c-b2a9-4877-a9aa-99a7233b1168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/event/single?periodId={{schoolperiodid}}","description":"Get list of single events
\nInput variables
\nperiod: id of the School Period
\ndateFrom: minimum event date (optional, UTC)
example: 2023-12-31T09:00:00
dateTo: maxumum event date (optional, UTC)
example: 2023-12-31T09:00:00
Add single event
\n","urlObject":{"path":["dreamclassapi","v1","calendar","event","single "],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"e7a5d367-e614-416b-bab0-457700dfdec0","name":"AddSingleEvent","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDatetime\": \"2024-11-07T14:00:00\",\r\n \"title\": \"Weekly Standup\",\r\n \"description\": \"Weekly team standup meeting\",\r\n \"duration\": 10,\r\n \"visibleToStudents\": false,\r\n \"visibleToProfessors\": true,\r\n \"semester\": {\"id\": 1}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/single"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 18,\n \"startDatetime\": \"2024-11-07T14:00:00\",\n \"title\": \"Weekly Standup\",\n \"description\": \"Weekly team standup meeting\",\n \"duration\": 10,\n \"visibleToStudents\": false,\n \"visibleToProfessors\": true\n} "}],"_postman_id":"26126e89-5946-40e4-9720-3c852bb01e1a"},{"name":"UpdateSingleEvent","id":"02d6d3a1-caca-4350-bc5e-1e4d17f23a14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 18,\r\n \"startDatetime\": \"2024-11-07T14:00:00\",\r\n \"title\": \"Weekly Standup\",\r\n \"description\": \"Weekly team standup meeting\",\r\n \"duration\": 10,\r\n \"visibleToStudents\": false,\r\n \"visibleToProfessors\": true\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/single/{{id}}","description":"Update single event
\n","urlObject":{"path":["dreamclassapi","v1","calendar","event","single","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"484034c8-cfcf-433c-8ad4-21264d40e7de","name":"UpdateSingleEvent","originalRequest":{"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 18,\r\n \"startDatetime\": \"2024-11-07T14:00:00\",\r\n \"title\": \"Weekly Standup\",\r\n \"description\": \"Weekly team standup meeting\",\r\n \"duration\": 10,\r\n \"visibleToStudents\": false,\r\n \"visibleToProfessors\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/single/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 18,\n \"startDatetime\": \"2024-11-07T14:00:00\",\n \"title\": \"Weekly Standup\",\n \"description\": \"Weekly team standup meeting\",\n \"duration\": 10,\n \"visibleToStudents\": false,\n \"visibleToProfessors\": true\n} "}],"_postman_id":"02d6d3a1-caca-4350-bc5e-1e4d17f23a14"},{"name":"DeleteSingleEvent","id":"2acbe6ab-ef6c-4522-bba6-07aab8b1aa05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/event/single/{{id}}","description":"Delete single event
\n","urlObject":{"path":["dreamclassapi","v1","calendar","event","single","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"867844dd-bf2d-401b-be3d-0c89b4d7e5f9","name":"UpdateSingleEvent","originalRequest":{"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 18,\r\n \"startDatetime\": \"2024-11-07T14:00:00\",\r\n \"title\": \"Weekly Standup\",\r\n \"description\": \"Weekly team standup meeting\",\r\n \"duration\": 10,\r\n \"visibleToStudents\": false,\r\n \"visibleToProfessors\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/single/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 18,\n \"startDatetime\": \"2024-11-07T14:00:00\",\n \"title\": \"Weekly Standup\",\n \"description\": \"Weekly team standup meeting\",\n \"duration\": 10,\n \"visibleToStudents\": false,\n \"visibleToProfessors\": true\n} "}],"_postman_id":"2acbe6ab-ef6c-4522-bba6-07aab8b1aa05"},{"name":"GetRecurringEvents","id":"00ec4088-cdbd-4c9e-a112-d5cb68c0ca9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/event/recurring?periodId={{schoolperiodid}}","description":"Get list of recurring events
\nInput variables
\nAdd recurring event
\nThis API endpoint allows you to add a recurring event by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the event's start date and recurrence pattern.
rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule should consist of:
\nA DTSTART element on the first line, specifying the start date and time of the event.
An RRULE element on the second line, specifying the recurrence pattern (e.g., daily, weekly, monthly).
Each element should be on a separate line, separated by a newline character (`\\n`).\n\nUpdate recurring event
\nThis API endpoint allows you to update a recurring event by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the event's start date and recurrence pattern.
rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule should consist of:
\nA DTSTART element on the first line, specifying the start date and time of the event.
An RRULE element on the second line, specifying the recurrence pattern (e.g., daily, weekly, monthly).
Each element should be on a separate line, separated by a newline character (`\\n`).\n\nDelete recurring event
\n","urlObject":{"path":["dreamclassapi","v1","calendar","event","recurring","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"3510b2a7-3be3-4b64-bafd-adb7a91a5530","name":"DeleteRecurringEvent","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\r\n \"id\":10,\r\n \"title\": \"Math\",\r\n \"description\": null,\r\n \"duration\": 15,\r\n \"createdBy\": \"test@mail.com\",\r\n \"visibleToStudents\": true,\r\n \"visibleToProfessors\": true,\r\n \"rrule\": \"DTSTART;TZID=US/Pacific:20241022T093000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/recurring/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": 10,\n \"title\": \"Math\",\n \"description\": null,\n \"duration\": 15,\n \"createdBy\": \"test@mail.com\",\n \"visibleToStudents\": true,\n \"visibleToProfessors\": true,\n \"rrule\": \"DTSTART;TZID=US/Pacific:20241022T093000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1\"\n } "}],"_postman_id":"07396874-134d-4592-b224-b0e5b6a6bd36"},{"name":"GetSingleLectures","id":"c2b805f3-0485-468f-9c2e-90001beb40ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single?periodId={{schoolperiodid}}","description":"Get list of single lectures
\nInput variables
\nperiod: id of the School Period
\ndateFrom: minimum event date (optional, UTC)
example: 2023-12-31T09:00:00
dateTo: maxumum event date (optional, UTC)
example: 2023-12-31T09:00:00
Add single lecture
\nLecture status
\n1: SCHEDULED
\n2: COMPLETED
\n3: CANCELLED
\n4: DELETED
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","single"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"34dad33d-71b6-465b-b816-9b56031ca573","name":"AddSingleLecture","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Sample Lecture\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"scheduledAt\": \"2024-11-08\",\r\n \"startDateTime\": \"2024-11-08T10:00:00\",\r\n \"status\": 1,\r\n \"duration\": 90,\r\n \"privateNotes\": \"These are private notes.\",\r\n \"publicNotes\": \"These are public notes.\",\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"http://example.com/meeting\",\r\n \"meetingPassword\": \"password123\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10,\n \"title\": \"Sample Lecture\",\n \"classCourse\": {\n \"id\": 46\n },\n \"scheduledAt\": \"2024-11-08\",\n \"startDateTime\": \"2024-11-08T10:00:00\",\n \"status\": 1,\n \"duration\": 90,\n \"privateNotes\": \"These are private notes.\",\n \"publicNotes\": \"These are public notes.\",\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"http://example.com/meeting\",\n \"meetingPassword\": \"password123\"\n}"}],"_postman_id":"c1759ffd-e1fe-4f7f-8e05-0b45503014af"},{"name":"UpdateSingleLecture","id":"a6e6aa1c-7280-4008-8e0c-b6e7f6c28534","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 10,\r\n \"title\": \"Sample Lecture\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"scheduledAt\": \"2024-11-08\",\r\n \"startDateTime\": \"2024-11-08T10:00:00\",\r\n \"status\": 1,\r\n \"duration\": 90,\r\n \"privateNotes\": \"These are private notes.\",\r\n \"publicNotes\": \"These are public notes.\",\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"http://example.com/meeting\",\r\n \"meetingPassword\": \"password123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single","description":"Update single lecture
\nLecture status
\n1: SCHEDULED
\n2: COMPLETED
\n3: CANCELLED
\n4: DELETED
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","single"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"4fa8e414-e02b-4caa-a890-9362392e7bbf","name":"UpdateSingleLecture","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 10,\r\n \"title\": \"Sample Lecture\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"scheduledAt\": \"2024-11-08\",\r\n \"startDateTime\": \"2024-11-08T10:00:00\",\r\n \"status\": 1,\r\n \"duration\": 90,\r\n \"privateNotes\": \"These are private notes.\",\r\n \"publicNotes\": \"These are public notes.\",\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"http://example.com/meeting\",\r\n \"meetingPassword\": \"password123\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10,\n \"title\": \"Sample Lecture\",\n \"classCourse\": {\n \"id\": 46\n },\n \"scheduledAt\": \"2024-11-08\",\n \"startDateTime\": \"2024-11-08T10:00:00\",\n \"status\": 1,\n \"duration\": 90,\n \"privateNotes\": \"These are private notes.\",\n \"publicNotes\": \"These are public notes.\",\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"http://example.com/meeting\",\n \"meetingPassword\": \"password123\"\n}"}],"_postman_id":"a6e6aa1c-7280-4008-8e0c-b6e7f6c28534"},{"name":"DeleteSingleLecture","id":"4ae5b750-79dc-45bf-b181-1566b969f814","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single/{{id}}","description":"Delete single lecture
\nThe call will fail if the specified entity is associated with other entities such as attendance
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","single","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"ad1268fe-a51f-406f-8932-51657ac8da3a","name":"DeleteSingleLecture","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 10,\r\n \"title\": \"Sample Lecture\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"scheduledAt\": \"2024-11-08\",\r\n \"startDateTime\": \"2024-11-08T10:00:00\",\r\n \"status\": 1,\r\n \"duration\": 90,\r\n \"privateNotes\": \"These are private notes.\",\r\n \"publicNotes\": \"These are public notes.\",\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"http://example.com/meeting\",\r\n \"meetingPassword\": \"password123\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/lecture/single/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10,\n \"title\": \"Sample Lecture\",\n \"classCourse\": {\n \"id\": 46\n },\n \"scheduledAt\": \"2024-11-08\",\n \"startDateTime\": \"2024-11-08T10:00:00\",\n \"status\": 1,\n \"duration\": 90,\n \"privateNotes\": \"These are private notes.\",\n \"publicNotes\": \"These are public notes.\",\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"http://example.com/meeting\",\n \"meetingPassword\": \"password123\"\n}"}],"_postman_id":"4ae5b750-79dc-45bf-b181-1566b969f814"},{"name":"GetRecurringLectures","id":"b271e19c-6b39-41e6-8345-0ba69dc3333d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/lecture/recurring?periodId={{schoolperiodid}}","description":"Get list of recurring lectures
\nInput variables
\nAdd recurring lecture
\nThis API endpoint allows you to add a recurring lecture by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the event's start date and recurrence pattern.
rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule should consist of:
\nA DTSTART element on the first line, specifying the start date and time of the lecture.
An RRULE element on the second line, specifying the recurrence pattern (e.g., daily, weekly, monthly). be on a separate line, separated by a newline character (`\\n`).
Each element should be on a separate line, separated by a newline character (\\n).
Lecture status
\n1: SCHEDULED
\n2: COMPLETED
\n3: CANCELLED
\n4: DELETED
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","recurring "],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"93861968-5f77-4e0c-8193-4d3fccca8af6","name":"AddRecurringLecture","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"startDateTime\": \"2024-11-05T10:10:00\",\r\n \"title\": \"Introduction to Programming\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"duration\": 60,\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"https://example.com/meeting\",\r\n \"meetingPassword\": \"password123\",\r\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/recurring"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12,\n \"startDateTime\": \"2024-11-05T10:10:00\",\n \"title\": \"Introduction to Programming\",\n \"classCourse\": {\n \"id\": 46\n },\n \"duration\": 60,\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"https://example.com/meeting\",\n \"meetingPassword\": \"password123\",\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\n}"}],"_postman_id":"1261467e-e57d-4a23-9f79-bbc1fc0a6d4a"},{"name":"UpdateRecurringLecture","id":"2b248b60-96ed-4887-a911-9b6e79e8eac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 12,\r\n \"startDateTime\": \"2024-11-05T10:10:00\",\r\n \"title\": \"Introduction to Programming\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"duration\": 60,\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"https://example.com/meeting\",\r\n \"meetingPassword\": \"password123\",\r\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/lecture/recurring/{{id}}","description":"Update recurring lecture
\nThis API endpoint allows you to update a recurring lecture by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the event's start date and recurrence pattern.
rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule should consist of:
\nA DTSTART element on the first line, specifying the start date and time of the lecture.
An RRULE element on the second line, specifying the recurrence pattern (e.g., daily, weekly, monthly). be on a separate line, separated by a newline character (`\\n`).
Each element should be on a separate line, separated by a newline character (\\n).
Lecture status
\n1: SCHEDULED
\n2: COMPLETED
\n3: CANCELLED
\n4: DELETED
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","recurring","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"956ab2a3-0db3-4231-98b4-33b21aa1db12","name":"UpdateRecurringLecture","originalRequest":{"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 12,\r\n \"startDateTime\": \"2024-11-05T10:10:00\",\r\n \"title\": \"Introduction to Programming\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"duration\": 60,\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"https://example.com/meeting\",\r\n \"meetingPassword\": \"password123\",\r\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/recurring/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12,\n \"startDateTime\": \"2024-11-05T10:10:00\",\n \"title\": \"Introduction to Programming\",\n \"classCourse\": {\n \"id\": 46\n },\n \"duration\": 60,\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"https://example.com/meeting\",\n \"meetingPassword\": \"password123\",\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\n}"}],"_postman_id":"2b248b60-96ed-4887-a911-9b6e79e8eac2"},{"name":"DeleteRecurringLecture","id":"2e82e512-d0b0-45fb-a3ad-a7ecf3f2bbbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/calendar/lecture/recurring/{{id}}","description":"Delete recurring lecture
\nThe call will fail if the specified entity is associated with other entities such as attendance
\n","urlObject":{"path":["dreamclassapi","v1","calendar","lecture","recurring","{{id}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"a412e75f-66a7-4241-97ec-0bd0d7845dba","name":"UpdateRecurringLecture","originalRequest":{"method":"DELETE","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 12,\r\n \"startDateTime\": \"2024-11-05T10:10:00\",\r\n \"title\": \"Introduction to Programming\",\r\n \"classCourse\": {\r\n \"id\": 46\r\n },\r\n \"duration\": 60,\r\n \"classroom\": {\r\n \"id\": 8\r\n },\r\n \"meetingLink\": \"https://example.com/meeting\",\r\n \"meetingPassword\": \"password123\",\r\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/calendar/event/recurring/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12,\n \"startDateTime\": \"2024-11-05T10:10:00\",\n \"title\": \"Introduction to Programming\",\n \"classCourse\": {\n \"id\": 46\n },\n \"duration\": 60,\n \"classroom\": {\n \"id\": 8\n },\n \"meetingLink\": \"https://example.com/meeting\",\n \"meetingPassword\": \"password123\",\n \"rrule\": \"DTSTART;TZID=USA/Pacific:20241101T130000\\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1\"\n}"}],"_postman_id":"2e82e512-d0b0-45fb-a3ad-a7ecf3f2bbbc"}],"id":"197826d0-620a-494c-9558-a485169d7499","_postman_id":"197826d0-620a-494c-9558-a485169d7499","description":""},{"name":"Curriculum","item":[{"name":"GetSchoolPeriods","id":"e771cdd6-a2b8-4aff-8c31-a5458df86952","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiods/list","description":"Get a list of Schools Periods
\n","urlObject":{"path":["dreamclassapi","v1","curriculum","schoolperiods","list"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"924af6f9-19a0-4d11-8c31-04840f1d561b","name":"GetSchoolPeriods","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiods/list"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"name\": \"Dec 2023 - Oct 2024\",\r\n \"schoolyear\": \"\",\r\n \"shortName\": \"Y1,\r\n \"startDate\": \"2023-12-11\",\r\n \"endDate\": \"2024-10-11\",\r\n \"duration\": 11.0\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"2024-2025\",\r\n \"schoolyear\": null,\r\n \"shortName\": \"Y2\",\r\n \"startDate\": \"2024-03-28\",\r\n \"endDate\": \"2024-04-30\",\r\n \"duration\": null\r\n }\r\n]"}],"_postman_id":"e771cdd6-a2b8-4aff-8c31-a5458df86952"},{"name":"GetSchoolCourses","id":"9c20ced8-b8dd-4f79-97f6-676bdc5e1d9e","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/courses/list","description":"Get a list of School Courses
\n","urlObject":{"path":["dreamclassapi","v1","curriculum","courses","list"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"818d7dcd-00ca-4017-bac8-ecbc0e9bd5e4","name":"GetSchoolCourses","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/courses/list"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"name\": \"Writing\",\r\n \"id\": 44,\r\n \"units\": null,\r\n \"description\": null,\r\n \"code\": null,\r\n \"teachingHours\": null\r\n },\r\n {\r\n \"name\": \"Math \",\r\n \"id\": 40,\r\n \"units\": 2.0,\r\n \"description\": null,\r\n \"code\": null,\r\n \"teachingHours\": null\r\n }\r\n]"}],"_postman_id":"9c20ced8-b8dd-4f79-97f6-676bdc5e1d9e"},{"name":"GetPeriodClasses","id":"524a37f3-aeb0-45d6-8e1c-a2c34311ca96","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiod/{{schoolPeriodId}}/classes","description":"Get a list of School Period Classes
\n","urlObject":{"path":["dreamclassapi","v1","curriculum","schoolperiod","{{schoolPeriodId}}","classes"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"765d3718-3621-4172-b531-08ff406c8317","name":"GetPeriodClasses","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiod/{{schoolPeriodId}}/classes"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"name\": \"1st Grade\",\r\n \"id\": 17,\r\n \"description\": null,\r\n \"code\": null,\r\n \"endDate\": \"2024-10-11\",\r\n \"startDate\": \"2023-12-11\",\r\n \"schoolTags\": [],\r\n \"capacity\": null\r\n },\r\n {\r\n \"name\": \"2rd Grade\",\r\n \"id\": 18,\r\n \"description\": null,\r\n \"code\": null,\r\n \"endDate\": \"2024-10-11\",\r\n \"startDate\": \"2023-12-11\",\r\n \"schoolTags\": [],\r\n \"capacity\": null\r\n }\r\n]"}],"_postman_id":"524a37f3-aeb0-45d6-8e1c-a2c34311ca96"},{"name":"GetPeriodClassCourses","id":"a77e507d-b7d4-4e0a-a405-0814e8972e10","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiod/{{schoolPeriodId}}/classcourses","description":"Get a list of Schools Periods
\n","urlObject":{"path":["dreamclassapi","v1","curriculum","schoolperiod","{{schoolPeriodId}}","classcourses"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"6f8d5b26-5851-4783-a868-9c9164afbb36","name":"GetPeriodClassCourses","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/schoolperiod/{{schoolPeriodId}}/classcourses "},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 273,\r\n \"classId\": 98,\r\n \"courseId\": 48\r\n },\r\n {\r\n \"id\": 274,\r\n \"classId\": 98,\r\n \"courseId\": 46\r\n }\r\n]"}],"_postman_id":"a77e507d-b7d4-4e0a-a405-0814e8972e10"},{"name":"Levels","id":"4644c337-dd1f-434d-a965-2230358b8c60","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/level","description":"Get a list of Levels
\n","urlObject":{"path":["dreamclassapi","v1","curriculum","level"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"108648b1-7b88-46ee-b602-0aa526d930fc","name":"Levels","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/curriculum/level"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"position\": 12,\r\n \"name\": \"Grade 12\",\r\n \"id\": 13,\r\n \"code\": null,\r\n \"parentLevelId\": 21\r\n },\r\n {\r\n \"position\": 16,\r\n \"name\": \"Playgroup\",\r\n \"id\": 18,\r\n \"code\": \"test\",\r\n \"parentLevelId\": 17\r\n }\r\n]"}],"_postman_id":"4644c337-dd1f-434d-a965-2230358b8c60"}],"id":"5fe06c55-c3b5-44d9-b33b-e3f62e9ed30c","_postman_id":"5fe06c55-c3b5-44d9-b33b-e3f62e9ed30c","description":""},{"name":"Fees","item":[{"name":"GetPeriodFees","id":"b7e2a860-2073-4182-a51b-ea0b37205b40","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/financial/fees/schoolperiod/1/list","description":"Get a list of all fees in a single period. Result also includes application fees which are applicable to all School Periods
\nInput variables
\nCreates new School Fees
\nInput variables
\nBulk Assign Fees to Students
\nInput variables
\nstudentIds
\nfeesIds
\ninstallmentPlan (1 | 2 | 3)
\n1 = apply all installments from the fee start date
\n2 = apply installments from next month
\n3 = appy installments from this month
\nBulk Unassign Fees from Students
\nInput variables
\nUpdate editable fields of a fee
\nInput variables
\nDeletes a single Fee
\nInput variables
\nGet a list of grade mappings configured
\nColors: Check https://tailwindcss.com/docs/colors for colors
\n","urlObject":{"path":["dreamclassapi","v1","grading","grade-mapping"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"9a7ca27f-9155-410f-8ee1-091e294b0f03","name":"GradeMapping","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/grading/grade-mapping "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2,\n \"name\": \"Only Colors\",\n \"conditionalValues\": [\n {\n \"to\": 100,\n \"gpa\": 2,\n \"from\": 50,\n \"apGpa\": 6,\n \"color\": \"green-50\",\n \"display\": \"B\",\n \"honorsGpa\": 3,\n \"includeTo\": true,\n \"includeFrom\": true\n },\n {\n \"to\": 50,\n \"gpa\": 1,\n \"from\": 0,\n \"apGpa\": 2,\n \"color\": \"red-50\",\n \"display\": \"A\",\n \"honorsGpa\": 1,\n \"includeTo\": null,\n \"includeFrom\": true\n }\n ],\n \"institution\": {\n \"id\": 1\n },\n \"informationText\": \"Grading Scale:
\\nA: 50-100
\\nB: 0-50
\"\n }\n]"}],"_postman_id":"ef689a78-9f00-400a-a5f4-1b3954cbcaf2"},{"name":"Gradebook","id":"1a8fad13-44d0-4158-8bb0-c83e7951115a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/grading/gradebook?classCourseId={{classCourseId}}","description":"Get a list of the grades of a gradebook for the specified class course
\nClassCourse: Check GetPeriodClassCourses call
\nGradeMapping: Check GradeMapping call
\nParentSimpleGradeId: Self referencing to another grade from the list
\nType:
4 -> Folder
5 -> Point grade
6 -> Grade
7 -> Final Grade (AVG)
Colors: Check https://tailwindcss.com/docs/colors for colors
\n","urlObject":{"path":["dreamclassapi","v1","grading","gradebook"],"host":["{{server}}"],"query":[{"description":{"content":"Class course id of the gradebook
\n","type":"text/plain"},"key":"classCourseId","value":"{{classCourseId}}"}],"variable":[]}},"response":[{"id":"e2a95639-4cb8-45eb-9d92-73f8df1062a0","name":"Gradebook","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/grading/gradebook?classCourseId={{classCourseId}} ","host":["{{server}}"],"path":["dreamclassapi","v1","grading","gradebook"],"query":[{"key":"classCourseId","value":"{{classCourseId}} "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{ \n \"id\": 66,\n \"classCourseId\": 70,\n \"grades\": [\n{\n \"id\": 420,\n \"name\": \"Math Tests\",\n \"color\": \"red-600\",\n \"position\": 4,\n \"weight\": 1.0,\n \"type\": 4,\n \"gradeMappingId\": null,\n \"parentSimpleGradeId\": null\n },\n {\n \"id\": 130,\n \"name\": \"Test1\",\n \"color\": \"cyan-600\",\n \"position\": 1,\n \"weight\": 1.0,\n \"type\": 6,\n \"gradeMappingId\": 3,\n \"parentSimpleGradeId\": 420\n }\n]\n}\n"}],"_postman_id":"1a8fad13-44d0-4158-8bb0-c83e7951115a"},{"name":"GradebookGradeValues","id":"acf7a01f-b168-4c1b-8845-fd99a8cc05dc","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/grading/gradebook/values?classCourseId={{classCourseId}}&periodStudentId={{periodStudentId}}","description":"Get a list of the grade values of a gradebook for the specified class course. Optionally filter by student
\nClassCourse: Check GetPeriodClassCourses call
\nPeriodStudentId: Check GetPeriodStudents call
\nSimpleGradeId: Check Gradebook call
\n","urlObject":{"path":["dreamclassapi","v1","grading","gradebook","values"],"host":["{{server}}"],"query":[{"description":{"content":"Class course id of the gradebook
\n","type":"text/plain"},"key":"classCourseId","value":"{{classCourseId}}"},{"description":{"content":"Id of period student (optional)
\n","type":"text/plain"},"key":"periodStudentId","value":"{{periodStudentId}}"}],"variable":[]}},"response":[{"id":"57266878-609d-42a4-9f72-518f64829768","name":"GradebookGradeValues","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/grading/gradebook/values?classCourseId={{classCourseId}}&periodStudentId={{periodStudentId}}","host":["{{server}}"],"path":["dreamclassapi","v1","grading","gradebook","values"],"query":[{"key":"classCourseId","value":"{{classCourseId}}"},{"key":"periodStudentId","value":"{{periodStudentId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 211,\n \"comment\": \"Sample Comment\",\n \"creationDate\": \"2025-02-03T00:00:00.000+00:00\",\n \"simpleGradeId\": 130,\n \"studentsemesterinfoid\": 34,\n \"value\": 70.0\n },\n {\n \"id\": 51,\n \"comment\": null,\n \"creationDate\": \"2024-02-08T00:00:00.000+00:00\",\n \"simpleGradeId\": 130,\n \"studentsemesterinfoid\": 34,\n \"value\": 85.0\n }\n]\n"}],"_postman_id":"acf7a01f-b168-4c1b-8845-fd99a8cc05dc"},{"name":"AddGradebook","id":"429f3eea-be35-460f-957a-f002fe3f73c4","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/grading/gradebook?classCourseId={{classCourseId}}","description":"Create a gradebook for the specified class course
\nClassCourse: Check GetPeriodClassCourses call
\n","urlObject":{"path":["dreamclassapi","v1","grading","gradebook"],"host":["{{server}}"],"query":[{"description":{"content":"Class course id of the gradebook
\n","type":"text/plain"},"key":"classCourseId","value":"{{classCourseId}}"}],"variable":[]}},"response":[{"id":"50cb2ac3-f504-4871-9252-fd8e34673c41","name":"AddGradebook","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/grading/gradebook?classCourseId={{classCourseId}}","host":["{{server}}"],"path":["dreamclassapi","v1","grading","gradebook"],"query":[{"key":"classCourseId","value":"{{classCourseId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 567,\n \"classCourseId\": 68 \n}\n"}],"_postman_id":"429f3eea-be35-460f-957a-f002fe3f73c4"},{"name":"AddGradebookGrade","id":"8e81a246-2151-4c6d-be67-2e25413e8791","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test Grade\",\r\n \"creationDate\": \"2025-08-22\",\r\n \"parentSimpleGrade\": {\"id\":420},\r\n \"type\": 6,\r\n \"color\": \"red-900\",\r\n \"gradeMapping\": {\r\n \"id\": 1\r\n },\r\n \"position\": 1,\r\n \"weight\": 1,\r\n \"maxGrade\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/grading/gradebook/grade?classCourseId={{classCourseId}}","description":"Add a new grade in a gradebook for the specified class course (gradebook should have already been created)
\nClassCourse: Check GetPeriodClassCourses call
\nGradeMapping: Check GradeMapping call
\nParentSimpleGradeId: Self referencing to another grade from the the gradebook, check Gradebook call
\nType:
4 -> Folder
5 -> Point grade
6 -> Grade
Colors: Check https://tailwindcss.com/docs/colors for colors
\n","urlObject":{"path":["dreamclassapi","v1","grading","gradebook","grade"],"host":["{{server}}"],"query":[{"description":{"content":"Class course id of the gradebook
\n","type":"text/plain"},"key":"classCourseId","value":"{{classCourseId}}"}],"variable":[]}},"response":[{"id":"73f197d8-4784-4ed5-9403-b6fcddd6d3ff","name":"AddGradebookGrade","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test Grade\",\r\n \"creationDate\": \"2025-08-22\",\r\n \"parentSimpleGrade\": {\"id\":420},\r\n \"type\": 6,\r\n \"color\": \"green-900\",\r\n \"gradeMapping\": {\r\n \"id\": 1\r\n },\r\n \"position\": 1,\r\n \"weight\": 1,\r\n \"maxGrade\": null\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{server}}/dreamclassapi/v1/grading/gradebook/grade?classCourseId={{classCourseId}}","host":["{{server}}"],"path":["dreamclassapi","v1","grading","gradebook","grade"],"query":[{"key":"classCourseId","value":"{{classCourseId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 567,\n \"name\": \"Test Grade\",\n \"color\": \"green-900\",\n \"position\": 1,\n \"weight\": 1.0,\n \"type\": 6,\n \"gradeMappingId\": 1,\n \"parentSimpleGradeId\": 420\n}\n"}],"_postman_id":"8e81a246-2151-4c6d-be67-2e25413e8791"},{"name":"AddGradebookGradeValue","id":"29bf5611-cf52-4683-afce-3a27ffe945a1","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\": \"85\",\r\n \"simpleGrade\": {\r\n \"id\": 564\r\n },\r\n \"creationDate\": \"2025-08-22\",\r\n \"comment\": \"Sample comment\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/grading/gradebook/values/add?classCourseId={{classCourseId}}&periodStudentId={{periodStudentId}}","description":"Add a new value for a grade in a gradebook for the specified class course
\nClassCourse: Check GetPeriodClassCourses call
\nPeriodStudentId: Check GetPeriodStudents call
\nSimpleGrade: Check Gradebook call
\n","urlObject":{"path":["dreamclassapi","v1","grading","gradebook","values","add"],"host":["{{server}}"],"query":[{"description":{"content":"Class course id of the gradebook
\n","type":"text/plain"},"key":"classCourseId","value":"{{classCourseId}}"},{"description":{"content":"Id of period student
\n","type":"text/plain"},"key":"periodStudentId","value":"{{periodStudentId}}"}],"variable":[]}},"response":[{"id":"5deb51e3-ba83-47e2-96f6-6833d14d0f94","name":"AddGradebookGradeValue","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"value\": \"85\",\r\n \"simpleGrade\": {\r\n \"id\": 564\r\n },\r\n \"creationDate\": \"2025-08-22\",\r\n \"comment\": \"Sample comment\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{server}}/dreamclassapi/v1/grading/gradebook/values/add?classCourseId={{classCourseId}}&periodStudentId={{periodStudentId}}","host":["{{server}}"],"path":["dreamclassapi","v1","grading","gradebook","values","add"],"query":[{"key":"classCourseId","value":"{{classCourseId}}"},{"key":"periodStudentId","value":"{{periodStudentId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 372,\n \"comment\": \"Sample comment\",\n \"creationDate\": \"2025-08-22T00:00:00.000+00:00\",\n \"simpleGradeId\": 564,\n \"periodStudentId\": 102,\n \"value\": 85.0\n}"}],"_postman_id":"29bf5611-cf52-4683-afce-3a27ffe945a1"}],"id":"5487e03f-6e1a-4c55-9912-77b3269e1b70","_postman_id":"5487e03f-6e1a-4c55-9912-77b3269e1b70","description":""},{"name":"Invoices","item":[{"name":"GetInvoice","id":"fa57e52b-ba66-481f-b95e-213d0bfaff4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/financial/invoices/get/{{invoiceId}}","description":"Get details of a single invoice
\nInput variables
\nGet list of payment methods
\n","urlObject":{"path":["dreamclassapi","v1","financial","invoices","paymentmethods"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"08a419a4-8671-44d1-be4e-531546a98875","name":"GetPaymentMethods","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/financial/invoices/paymentmethods"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 1,\r\n \"translation\": \"PAYMENTMETHODS.CASH\",\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": 1\r\n },\r\n {\r\n \"id\": 2,\r\n \"translation\": \"PAYMENTMETHODS.BANK\",\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": 1\r\n },\r\n {\r\n \"id\": 3,\r\n \"translation\": \"PAYMENTMETHODS.ONLINE\",\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": 1\r\n },\r\n {\r\n \"id\": 4,\r\n \"translation\": \"PAYMENTMETHODS.CHECK\",\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": 1\r\n }\r\n]"}],"_postman_id":"1f6bd1b7-0c9c-4461-a597-10b524281e86"},{"name":"UpdateInvoice","id":"5157f836-321a-4dc0-8f8b-a236112ca1da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"publicNotes\": \"3213213\",\r\n \"privateNotes\": \"test\",\r\n \"issueDate\": \"2021-01-01\",\r\n \"invoiceRefId\": \"111\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/financial/invoices/update/{{invoiceId}}","description":"Update editable fields of a single invoice
\nInput variables
\nUpdate editable fields of a payment
\nInput variables
\npaymentId: number of the invoice
\njson representation of editable fields of a Payment
\npublicNotes
\nprivateNotes
\ndate
\nFor payment id check the GetInvoce endpoint
\n","urlObject":{"path":["dreamclassapi","v1","financial","invoices","payment","{{paymentId}} "],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"ea4b094c-6f16-4837-8e7e-a57d4ea91825","name":"UpdateInvoice","originalRequest":{"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"publicNotes\": \"test1\",\r\n \"privateNotes\": \"test2\",\r\n \"date\": \"2021-01-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/financial/invoices/payment/{{paymentId}} "},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 63,\r\n \"amount\": 1.0,\r\n \"publicNotes\": \"test1\",\r\n \"privateNotes\": \"test2\",\r\n \"paymentmethod\": {\r\n \"id\": 2,\r\n \"translation\": \"PAYMENTMETHODS.BANK\",\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": 1\r\n },\r\n \"createdAt\": \"2025-09-18T11:58:12.448+00:00\",\r\n \"date\": \"2021-01-01\",\r\n \"invoiceId\": 24\r\n}"}],"_postman_id":"8a14ffe3-7ec8-45b1-9032-680251a271c6"},{"name":"DeleteInvoice","id":"229802a1-5e84-4d3f-a46c-6b8da1851bf6","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/financial/invoices/delete/{{invoiceId}}","description":"Deletes a single invoice
\nInput variables
\nReturns a list of invoices based on issue date, due date and status
\nInput variables
\nUsed to issue a payment against an invoice.
\nInput variables
\ninvoiceId: number of the invoice (path variable)
\njson representation of a payment object
\namount (decimal)
\nprivateNotes (if any)
\npublicNotes (if any)
\npaymentmethod (1 Cash, 2 Bank Transfer, 3 Online, 4 Check,...)
\ncreatedAt (optional)
\nCreates a new Invoice
\nInput variables
\nGet a list of notes for the specified period and student
\nPeriod: Check the GetSchoolPeriods call
\nStudent: Check the GetStudent
\nSchool Tags: Check the Tags call
\n","urlObject":{"path":["dreamclassapi","v1","settings","notes"],"host":["{{server}}"],"query":[{"description":{"content":"Period Id
\n","type":"text/plain"},"key":"periodId","value":"{{periodId}}"},{"description":{"content":"Student Id (optional)
\n","type":"text/plain"},"key":"userId","value":"{{studentId}}"}],"variable":[]}},"response":[{"id":"673d0284-81ff-452e-9d03-cd910611b329","name":"Notes","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":{"raw":"{{server}}/dreamclassapi/v1/settings/notes?periodId={{periodId}}&userId={{studentId}}","host":["{{server}}"],"path":["dreamclassapi","v1","settings","notes"],"query":[{"key":"periodId","value":"{{periodId}}"},{"key":"userId","value":"{{studentId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 8,\n \"title\": \"Test Note\",\n \"notes\": \"Sample Note
\",\n \"createAt\": \"2024-03-20T17:33:55.890+00:00\",\n \"updatedAt\": \"2024-03-20T17:34:05.671+00:00\",\n \"userId\": 23,\n \"reporterId\": 27,\n \"schoolTags\": [23,24],\n \"visibleToStudent\": true,\n \"visibleToAdmins\": true,\n \"visibleToTeachers\": true,\n \"visibleToGuardians\": true,\n \"pinned\": null\n },\n {\n \"id\": 6,\n \"title\": \"Reminder\",\n \"notes\": \"Test in Math
\",\n \"createAt\": \"2024-01-31T11:19:43.029+00:00\",\n \"updatedAt\": \"2024-01-31T11:19:43.029+00:00\",\n \"userId\": 23,\n \"reporterId\": 25,\n \"schoolTags\": [],\n \"visibleToStudent\": true,\n \"visibleToAdmins\": true,\n \"visibleToTeachers\": true,\n \"visibleToGuardians\": true,\n \"pinned\": null\n }\n]"}],"_postman_id":"caab2544-a4c2-447c-bff3-adfefcad428e"},{"name":"AddNote","id":"f85f4889-236f-4c3b-b51d-8bce580b2f0a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Test Note\",\r\n \"notes\": \"Sample note
\",\r\n \"user\": {\r\n \"id\": 23\r\n },\r\n \"reporter\": {\r\n \"id\": 27\r\n },\r\n \"semester\": {\r\n \"id\": 1\r\n },\r\n \"schoolTags\": [\r\n {\r\n \"id\": 23\r\n }\r\n ],\r\n \"visibleToStudent\": true,\r\n \"visibleToAdmins\": false,\r\n \"visibleToTeachers\": true,\r\n \"visibleToGuardians\": false,\r\n \"pinned\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/settings/notes ","description":"Add a new note
\nSemester: Check the GetSchoolPeriods call
\nUser/Reporter: Check the GetStudent
\nSchool Tags: Check the Tags call
\n","urlObject":{"path":["dreamclassapi","v1","settings","notes "],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"4abc52dc-618f-406d-b91f-8172a03062b0","name":"AddNote","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Test Note\",\r\n \"notes\": \"Sample note
\",\r\n \"user\": {\r\n \"id\": 23\r\n },\r\n \"reporter\": {\r\n \"id\": 27\r\n },\r\n \"semester\": {\r\n \"id\": 1\r\n },\r\n \"schoolTags\": [\r\n {\r\n \"id\": 23\r\n }\r\n ],\r\n \"visibleToStudent\": true,\r\n \"visibleToAdmins\": false,\r\n \"visibleToTeachers\": true,\r\n \"visibleToGuardians\": false,\r\n \"pinned\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/settings/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 73,\n \"title\": \"Test Note\",\n \"notes\": \"Sample note
\",\n \"createat\": \"2025-08-30T14:11:23.293+00:00\",\n \"updatedAt\": \"2025-08-30T14:11:23.293+00:00\",\n \"userId\": 23,\n \"reportedId\": 27,\n \"schoolTags\": [\n 23\n ],\n \"visibleToStudent\": true,\n \"visibleToAdmins\": false,\n \"visibleToTeachers\": true,\n \"visibleToGuardians\": false,\n \"pinned\": true\n}"}],"_postman_id":"f85f4889-236f-4c3b-b51d-8bce580b2f0a"},{"name":"UpdateNote","id":"4327562a-edec-486a-b6bc-48f6052fe824","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Test Note\",\r\n \"notes\": \"Sample note
\",\r\n \"user\": {\r\n \"id\": 23\r\n },\r\n \"reporter\": {\r\n \"id\": 27\r\n },\r\n \"semester\": {\r\n \"id\": 1\r\n },\r\n \"schoolTags\": [\r\n {\r\n \"id\": 23\r\n },\r\n {\r\n \"id\": 24\r\n }\r\n ],\r\n \"visibleToStudent\": true,\r\n \"visibleToAdmins\": false,\r\n \"visibleToTeachers\": true,\r\n \"visibleToGuardians\": false,\r\n \"pinned\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/settings/notes/{{noteId}}","description":"Update an existing note
\nNote: Check the Notes call
\nSemester: Check the GetSchoolPeriods call
\nUser/Reporter: Check the GetStudent
\nSchool Tags: Check the Tags call
\n","urlObject":{"path":["dreamclassapi","v1","settings","notes","{{noteId}}"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"b4c8e2da-fddd-4736-817b-c42b165c64f5","name":"UpdateNote","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Test Note\",\r\n \"notes\": \"Sample note
\",\r\n \"user\": {\r\n \"id\": 23\r\n },\r\n \"reporter\": {\r\n \"id\": 27\r\n },\r\n \"semester\": {\r\n \"id\": 1\r\n },\r\n \"schoolTags\": [\r\n {\r\n \"id\": 23\r\n },\r\n {\r\n \"id\": 24\r\n }\r\n ],\r\n \"visibleToStudent\": true,\r\n \"visibleToAdmins\": false,\r\n \"visibleToTeachers\": true,\r\n \"visibleToGuardians\": false,\r\n \"pinned\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/settings/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 73,\n \"title\": \"Test Note\",\n \"notes\": \"Sample note
\",\n \"createat\": \"2025-08-30T14:11:23.293+00:00\",\n \"updatedAt\": \"2025-08-30T14:11:23.293+00:00\",\n \"userId\": 23,\n \"reportedId\": 27,\n \"schoolTags\": [\n 23,\n 24\n ],\n \"visibleToStudent\": true,\n \"visibleToAdmins\": false,\n \"visibleToTeachers\": true,\n \"visibleToGuardians\": false,\n \"pinned\": true\n}"}],"_postman_id":"4327562a-edec-486a-b6bc-48f6052fe824"}],"id":"273bcf43-efe6-48ba-a24c-30f479bf2376","_postman_id":"273bcf43-efe6-48ba-a24c-30f479bf2376","description":""},{"name":"Settings","item":[{"name":"Tags","id":"ee7a71c4-a96c-446d-b0f7-35ae2dbf72f1","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/settings/tag","description":"Get a list of School Tags
\nType:
CLAZZ -> Tags for classes
DC_FILE -> Tags for user files
MATERIAL_FILE -> Tags for learning material files
NOTE_CLASSES_COURSE -> Tags for class courses
NOTE_STUDENT -> Tags for student notes
NOTE_TEACHER -> Tags for teacher notes
PROFESSOR_TO_SEMESTER -> Tags for teachers
STUDENT_TO_SEMESTER -> Tags for students
Colors: Check https://tailwindcss.com/docs/colors for colors
\n","urlObject":{"path":["dreamclassapi","v1","settings","tag"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"eee186ae-7a2e-4ba6-a14e-c3cacff71142","name":"Tags","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/settings/tag "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[ \n {\n \"id\": 39,\n \"name\": \"Morning classes\",\n \"color\": \"deep-purple-400\",\n \"entityType\": \"CLAZZ\",\n \"parentSchoolTagId\": 37\n },\n {\n \"id\": 40,\n \"name\": \"Progress\",\n \"color\": \"deep-purple-300\",\n \"entityType\": \"NOTE_STUDENT\",\n \"parentSchoolTagId\": 22\n }\n]"}],"_postman_id":"ee7a71c4-a96c-446d-b0f7-35ae2dbf72f1"}],"id":"60d07eb2-46df-426a-82fb-2585bc80011e","_postman_id":"60d07eb2-46df-426a-82fb-2585bc80011e","description":""},{"name":"Students","item":[{"name":"GetStudent","id":"eb5e2c70-9120-4c0f-8367-9e02dd5cde4b","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/records/get/{{studentId}}","description":"Get details of a single student
\nInput variables
\nGet a list of students based on their lastname
\nInput variables
\nGet a list of the available custom fields for students
\n","urlObject":{"path":["dreamclassapi","v1","students","custom-fields"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"05a6c45b-db87-40ff-8468-fba40edc42de","name":"GetCustomFields","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/custom-fields"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"formField\": {\n \"row\": \"1\",\n \"type\": \"text\",\n \"label\": \"Passport Number\",\n \"selectOptions\": {},\n \"hiddenToStudents\": false,\n \"hiddenToTeachers\": false,\n \"hiddenToGuardians\": false,\n \"editableByStudents\": true,\n \"editableByTeachers\": true,\n \"editableByGuardians\": true\n },\n \"entityType\": \"STUDENT\",\n \"institution\": {\n \"id\": 1\n }\n },\n {\n \"id\": 202,\n \"formField\": {\n \"row\": 1,\n \"type\": \"custom-field-select\",\n \"label\": \"Type\",\n \"selectOptions\": {\n \"options\": [\n {\n \"name\": \"Full time\"\n },\n {\n \"name\": \"Part time\"\n }\n ]\n },\n \"hiddenToStudents\": false,\n \"hiddenToTeachers\": false,\n \"hiddenToGuardians\": false,\n \"editableByStudents\": true,\n \"editableByTeachers\": true,\n \"editableByGuardians\": true\n },\n \"entityType\": \"STUDENT\",\n \"institution\": {\n \"id\": 1\n }\n }\n]"}],"_postman_id":"5ae208c1-38dc-441b-890c-6011a806405c"},{"name":"GetRelations","id":"af11d360-c244-47e0-bbf5-c33420265b57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/relations","description":"Get a list of the available relations for guardians/students
\n","urlObject":{"path":["dreamclassapi","v1","students","relations"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"6eafaf5c-06f2-4546-bf2d-7800c623a2b1","name":"GetRelations","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/relations"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"translation\": \"RELATION.FATHER\",\n \"institutionId\": 1\n },\n {\n \"id\": 2,\n \"translation\": \"RELATION.MOTHER\",\n \"institutionId\": 1\n }\n]"}],"_postman_id":"af11d360-c244-47e0-bbf5-c33420265b57"},{"name":"GetPeriodStudents","id":"cbe726d1-7ce6-4db4-9d02-7a4ea132487b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/schoolperiod/{{schoolPeriodId}}/list?studentId={{studentId}}","description":"Get details of all students of a single period.
\nSee also GetPeriodClassCourses
\nInput variables
\nId of student (optional)
\n","type":"text/plain"},"key":"studentId","value":"{{studentId}}"}],"variable":[]}},"response":[{"id":"3f98d703-c444-430f-a06f-61dfc4225d3c","name":"GetPeriodStudents","originalRequest":{"method":"GET","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"url":"{{server}}/dreamclassapi/v1/students/schoolperiod/{{schoolPeriodId}}/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\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]"}],"_postman_id":"cbe726d1-7ce6-4db4-9d02-7a4ea132487b"},{"name":"CreateStudent","id":"09f17566-995e-4ae1-bbe3-d355af76a03b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@company.com\",\r\n \"firstname\": \"George\",\r\n \"lastname\": \"Carry\",\r\n \"middlename\": \"John\",\r\n \"mobile\": \"123456789\",\r\n \"address\": \"Southgate 4\",\r\n \"gender\": \"male\",\r\n \"country\": \"United States\",\r\n \"city\": \"Sacramento\",\r\n \"telephone\": \"123456789\",\r\n \"birthdate\": \"2012-12-31\",\r\n \"birthplace\": \"Texas\",\r\n \"customFields\": {\r\n \"1\": \"value1\",\r\n \"2\": \"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/records/create","description":"Add a student record
\n","urlObject":{"path":["dreamclassapi","v1","students","records","create"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"d4ba1b70-ef3d-4cb0-97a0-28ad3ef2d57f","name":"CreateStudent","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@company.com\",\r\n \"firstname\": \"George\",\r\n \"lastname\": \"Carry\",\r\n \"middlename\": \"John\",\r\n \"mobile\": \"123456789\",\r\n \"address\": \"Southgate 4\",\r\n \"gender\": \"male\",\r\n \"country\": \"United States\",\r\n \"city\": \"Sacramento\",\r\n \"telephone\": \"123456789\",\r\n \"birthdate\": \"2012-12-31\",\r\n \"birthplace\": \"Texas\",\r\n \"customFields\": {\r\n \"1\": \"value1\",\r\n \"2\": \"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/records/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 189,\n \"email\": \"test@company.com\",\n \"firstname\": \"George\",\n \"lastname\": \"Carry\",\n \"middlename\": \"John\",\n \"mobile\": \"123456789\",\n \"address\": \"Southgate 4\",\n \"gender\": \"Male\",\n \"country\": \"United States\",\n \"city\": \"Sacramento\",\n \"telephone\": \"123456789\",\n \"birthdate\": \"2012-12-31\",\n \"birthplace\": \"Texas\",\n \"customFields\": {\n \"1\": \"value1\",\n \"2\": \"value2\"\n },\n \"schoolPeriods\": null,\n \"guardians\": null\n}"}],"_postman_id":"09f17566-995e-4ae1-bbe3-d355af76a03b"},{"name":"EnrollClass","id":"d64f678b-804d-4766-ae3f-6637896a66c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"classesToEnroll\": [\r\n {\r\n \"id\": 15\r\n },\r\n {\r\n \"id\": 14\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{studentPeriodId}}/register/class","description":"Enroll a student in classes.
\nThe studentPeriodId parameter is the id as returned by GetPeriodStudents call.
\nThe classesToEnroll values are the ids as returned by GetPeriodClasses call
\n","urlObject":{"path":["dreamclassapi","v1","students","periodstudent","{{studentPeriodId}}","register","class"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"be8652f4-4413-44f1-9d0b-aa4819ba9fcf","name":"EnrollClass","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"classesToEnroll\": [\r\n {\r\n \"id\": 15\r\n },\r\n {\r\n \"id\": 14\r\n }\r\n ] \r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{studentPeriodId}}/register/class "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[ \n {\n \"id\": 94,\n \"clazz\": {\n \"id\": 14\n }\n },\n {\n \"id\": 95,\n \"clazz\": {\n \"id\": 15\n }\n }\n]"}],"_postman_id":"d64f678b-804d-4766-ae3f-6637896a66c0"},{"name":"EnrollClassCourse","id":"073b2fd3-4ed4-47ee-9974-85e415163f8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"classesCourse\": {\r\n \"id\": 88\r\n }\r\n },\r\n {\r\n \"classesCourse\": {\r\n \"id\": 41\r\n }\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{studentPeriodId}}/register/classcourses","description":"Enroll a student in classe courses.
\nThe studentPeriodId parameter is the id as returned by GetPeriodStudents call.
\nThe classesCourse values are the ids as returned by GetPeriodClassCourses call.
\n","urlObject":{"path":["dreamclassapi","v1","students","periodstudent","{{studentPeriodId}}","register","classcourses"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"7de2831e-5e01-4c9c-9ce5-3d4c5f4d16d8","name":"EnrollClassCourse","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"classesCourse\": {\r\n \"id\": 88\r\n }\r\n },\r\n {\r\n \"classesCourse\": {\r\n \"id\": 41\r\n }\r\n }\r\n] ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{studentPeriodId}}/register/classcourses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 281, \n \"classesCourse\": {\n \"id\": 88\n }\n },\n {\n \"id\": 282,\n \"classesCourse\": {\n \"id\": 41\n }\n]"}],"_postman_id":"073b2fd3-4ed4-47ee-9974-85e415163f8b"},{"name":"ConnectGuardian","id":"ca752a16-0eb2-4191-99e6-8e75279200c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"student\": {\"id\": 119}, \r\n \"guardian\": {\r\n \"id\": 252,\r\n \"email\": \"test@test.com\",\r\n \"firstname\": \"firstname\",\r\n \"lastname\": \"lastname\",\r\n \"middlename\": null,\r\n \"mobile\": null,\r\n \"address\": null,\r\n \"gender\": \"Male\",\r\n \"country\": \"\",\r\n \"city\": \"\",\r\n \"telephone\": null,\r\n \"birthdate\": null,\r\n \"birthplace\": null,\r\n \"state\": null,\r\n \"zip\": null,\r\n \"customFields\": null\r\n }, \r\n \"relation\": {\"id\": 2}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/guardian/connect","description":"Connect a Guardian to a Student Record
\nIf the provided guardian ID is empty or does not exist, a new guardian record is created before it is connected to the student.
\n","urlObject":{"path":["dreamclassapi","v1","students","guardian","connect"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"2c06b3ba-7f37-4a8f-991a-ef5edb559e0e","name":"ConnectGuardian","originalRequest":{"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"student\": {\"id\": 119}, \r\n \"guardian\": {\r\n \"id\": 252,\r\n \"email\": \"test@test.com\",\r\n \"firstname\": \"firstname\",\r\n \"lastname\": \"lastname\",\r\n \"middlename\": null,\r\n \"mobile\": null,\r\n \"address\": null,\r\n \"gender\": \"Male\",\r\n \"country\": \"\",\r\n \"city\": \"\",\r\n \"telephone\": null,\r\n \"birthdate\": null,\r\n \"birthplace\": null,\r\n \"state\": null,\r\n \"zip\": null,\r\n \"customFields\": null\r\n }, \r\n \"relation\": {\"id\": 2}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/guardian/connect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":"{\n \"student\": {\"id\": 119}, \n \"guardian\": {\n \"id\": 252,\n \"email\": \"test@test.com\",\n \"firstname\": \"firstname\",\n \"lastname\": \"lastname\",\n \"middlename\": null,\n \"mobile\": null,\n \"address\": null,\n \"gender\": \"Male\",\n \"country\": \"\",\n \"city\": \"\",\n \"telephone\": null,\n \"birthdate\": null,\n \"birthplace\": null,\n \"state\": null,\n \"zip\": null,\n \"customFields\": null\n }, \n \"relation\": {\"id\": 2}\n}"}],"_postman_id":"ca752a16-0eb2-4191-99e6-8e75279200c4"},{"name":"PeriodStudentLevel","id":"ac2879a4-5445-49a9-81f6-9dafa2fac257","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 13\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{periodStudentId}}/level","description":"Set the level to a period student
\nPeriodStudentId: Check GetPeriodStudents call
\nThe body contains the id of the level: Check the Levels call
\n","urlObject":{"path":["dreamclassapi","v1","students","periodstudent","{{periodStudentId}}","level"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[{"id":"0fce815a-ff11-403b-8482-ff0e70c4ec38","name":"PeriodStudentLevel","originalRequest":{"method":"PATCH","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 13 \r\n} ","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/periodstudent/{{periodStudentId}}/level"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Access-Control-Allow-Headers","value":"x-requested-with, Content-Type, X-HTTP-Method-Override, Authorization, tenant"},{"key":"X-XSS-Protection","value":"0"},{"key":"Pragma","value":"no-cache"},{"key":"Date","value":"Mon, 16 Sep 2024 09:40:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, DELETE, PUT, PATCH"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Access-Control-Expose-Headers","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Access-Control-Max-Age","value":"3600"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"ac2879a4-5445-49a9-81f6-9dafa2fac257"},{"name":"UpdateStudent","id":"20e240f9-c281-489b-9317-092c047164ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"dreamclass-secret-key"},{"key":"value","value":"{{apiiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"tenant","value":"{{tenant}}"},{"key":"schoolCode","value":"{{schoolCode}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@company.com\",\r\n \"firstname\": \"George\",\r\n \"lastname\": \"Carry\",\r\n \"middlename\": \"John\",\r\n \"mobile\": \"123456789\",\r\n \"address\": \"Southgate 4\",\r\n \"gender\": \"male\",\r\n \"country\": \"United States\",\r\n \"city\": \"Sacramento\",\r\n \"telephone\": \"123456789\",\r\n \"birthdate\": \"2012-12-31\",\r\n \"birthplace\": \"Texas\",\r\n \"customFields\": {\r\n \"1\": \"value1\",\r\n \"2\": \"value2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/dreamclassapi/v1/students/records/update/{{studentId}}","description":"Update a student record
\nInput variables
\nWebhook related to student data, trigged upon
\nStudent created: STUDENT_CREATED
\nStudent updated: STUDENT_UPDATED
\nStudent deleted: STUDENT_DELETED
\nUsing the provided id, use the GetStudent API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"444846a0-f13a-48d1-9211-43f314b876ac"},{"name":"Student Period","id":"fa5ad847-7c45-4599-a4ce-7b0aee3ce0a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727862002901,\r\n \"id\": \"b3e6fa78-8672-4e8b-8431-7eebdabd25a2\",\r\n \"signature\": \"nGq8sspzZVWObaR4zUOLyQ29m/IBxxD716hKx5298No=\",\r\n \"type\": \"STUDENT_PERIOD_CREATED\",\r\n \"data\": {\r\n \"id\": 74,\r\n \"active\": true,\r\n \"studentId\": 76,\r\n \"addedAt\": \"2024-10-02T09:40:02.179+00:00\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url ","description":"Webhook related to student assigned to a period, trigged upon
\nStudent period created: STUDENT_PERIOD_CREATED
\nStudent period updated: STUDENT_PERIOD_UPDATED
\nStudent period deleted: STUDENT_PERIOD_DELETED
\nUsing the provided studentId, use the GetStudent API to retrieve more data. The provided id can be matched with the results of GetPeriodStudents
\n","urlObject":{"protocol":"https","host":["your-webhook-url "],"query":[],"variable":[]}},"response":[],"_postman_id":"fa5ad847-7c45-4599-a4ce-7b0aee3ce0a5"},{"name":"Student Class","id":"d3525438-1946-4356-97d6-90c7daff1fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727882727528,\r\n \"id\": \"613df5f8-c44f-439d-8f94-5c2d87aa18df\",\r\n \"signature\": \"k1XoUbe5HuuOLbsNqrXRUHhQeDNWWU5eY0h3DfamnjQ=\",\r\n \"type\": \"STUDENT_CLASS_CREATED\",\r\n \"data\": {\r\n \"id\": 45,\r\n \"registered\": true,\r\n \"startDate\": \"2023-12-11\",\r\n \"endDate\": \"2024-10-11\",\r\n \"addedAt\": \"2024-10-02T15:25:27.471+00:00\",\r\n \"classId\": 14,\r\n \"studentPeriodId\": 74\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to student assigned to a class, trigged upon
\nStudent class created: STUDENT_CLASS_CREATED
\nStudent class updated: STUDENT_CLASS_UPDATED
\nStudent class deleted: STUDENT_CLASS_DELETED
\nThe provided classId can be used in the GetPeriodClasses API. The studentPeriodId is the one returned in the Student Period webhook.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3525438-1946-4356-97d6-90c7daff1fa8"},{"name":"Student Course","id":"5ba90d04-2e75-4e10-a0be-ebf7f8ddc6ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727882727860,\r\n \"id\": \"4b32de97-dd28-4fb1-8126-129c2ff106dd\",\r\n \"signature\": \"ac7YipSwLgb7hm28jpnxbdLAfRlq6swR5n1qkfLmQ74=\",\r\n \"type\": \"STUDENT_COURSE_CREATED\",\r\n \"data\": {\r\n \"id\": 128,\r\n \"registered\": true,\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"addedAt\": \"2024-10-02T15:25:27.840+00:00\",\r\n \"classCourse\": {\r\n \"id\": 46,\r\n \"classid\": 14,\r\n \"courseId\": 45\r\n },\r\n \"studentPeriodId\": 74\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to student assigned to course in the context of a class, trigged upon
\nStudent course created: STUDENT_COURSE_CREATED
\nStudent course updated: STUDENT_COURSE_UPDATED
\nStudent course deleted: STUDENT_COURSE_DELETED
\nThe provided courseId can be used in the GetSchoolCourses API.The provided classId can be used in the GetPeriodClasses API. The studentPeriodId is the one returned in the Student Period webhook
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ba90d04-2e75-4e10-a0be-ebf7f8ddc6ab"},{"name":"Period","id":"d9710596-a330-475d-a007-153f7dc94172","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727883521394,\r\n \"id\": \"d0df8e25-10b5-477c-9d82-2e16c2a26f48\",\r\n \"signature\": \"6cs/CkypYhXApXCMXaCeU8NkhxRSM/bA+FZuIkDAykg=\",\r\n \"type\": \"PERIOD_CREATED\",\r\n \"data\": {\r\n \"id\": 54,\r\n \"name\": \"2024-2025\",\r\n \"shortName\": \"S4\",\r\n \"duration\": null,\r\n \"startDate\": \"2024-09-24\",\r\n \"endDate\": \"2024-12-25\",\r\n \"schoolyear\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url ","description":"Webhook related to school period, trigged upon
\nPeriod created: PERIOD_CREATED
\nPeriod updated: PERIOD_UPDATED
\nPeriod deleted: PERIOD_DELETED
\nUsing the provided id, use the GetSchoolPeriods API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url "],"query":[],"variable":[]}},"response":[],"_postman_id":"d9710596-a330-475d-a007-153f7dc94172"},{"name":"School","id":"379f2d1a-b3f6-4b85-a34b-30e86a21e379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727883521069,\r\n \"id\": \"ff35488a-9ce1-4798-970a-9e3c99b86380\",\r\n \"signature\": \"RJei86U5BjnDQ9cdd+YEzQtnUP5u/SA4EJWLGzN8cEE=\",\r\n \"type\": \"SCHOOL_CREATED\",\r\n \"data\": {\r\n \"id\": 59,\r\n \"name\": \"Sample School\",\r\n \"nameAlt\": \"My School\",\r\n \"companyName\": \"School Inc\",\r\n \"country\": \"USA\",\r\n \"telephone\": \"123456789\",\r\n \"email\": \"test@test.com\"\r\n }\r\n} ","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url ","description":"Webhook related to school/institution, trigged upon
\nSchool created: SCHOOL_CREATED
\nSchool updated: SCHOOL_UPDATED
\nWebhook related to courses, trigged upon
\nCourse created: COURSE_CREATED
\nCourse updated: COURSE_UPDATED
\nCourse deleted: COURSE_DELETED
\nUsing the provided id, use the GetSchoolCourse API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url "],"query":[],"variable":[]}},"response":[],"_postman_id":"338ae5be-8d8d-4a4c-ab25-2960bc1ec41a"},{"name":"Class","id":"6078d61d-5b34-45f6-ad95-96c76ce7fa8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727884291329,\r\n \"id\": \"bcfcfb2f-59ce-485f-8acf-e05281f61cb5\",\r\n \"signature\": \"Zz1/mrMBINl8ra5NvGPtff4orZyklf3l0sO4aRAOuq8=\",\r\n \"type\": \"CLASS_CREATED\",\r\n \"data\": {\r\n \"id\": 98,\r\n \"name\": \"Sample Class\",\r\n \"capacity\": 12,\r\n \"description\": \"Sample\",\r\n \"code\": \"cs-2\",\r\n \"startDate\": \"2023-12-11\",\r\n \"endDate\": \"2024-10-11\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to classes, trigged upon
\nClass created: CLASS_CREATED
\nClass updated: CLASS_UPDATED
\nClass deleted: CLASS_DELETED
\nUsing the provided id, use the GetPeriodClasses API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"6078d61d-5b34-45f6-ad95-96c76ce7fa8d"},{"name":"Invoice","id":"2f1fa682-5b66-4d44-8abc-0f0f09d629a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727884920561,\r\n \"id\": \"aa3a27d6-05b5-4fcd-bd04-505bfffacfc2\",\r\n \"signature\": \"4sB3kHjsoz0srhd/dd+55xSKhlFd/hUXzyrMIJWrXTM=\",\r\n \"type\": \"INVOICE_CREATED\",\r\n \"data\": {\r\n \"id\": 16,\r\n \"invoiceRefId\": \"abc123\",\r\n \"amount\": 300.0,\r\n \"status\": 1,\r\n \"fullname\": \"John Sample\",\r\n \"address\": \"Address 1\",\r\n \"telephone\": \"123456789\",\r\n \"email\": \"test@test.com\",\r\n \"createdAt\": \"2024-10-02T16:02:00.544+00:00\",\r\n \"issueDate\": \"2024-10-01\",\r\n \"dueDate\": \"2024-10-31\",\r\n \"privateNotes\": null,\r\n \"publicNotes\": null,\r\n \"fees\": [\r\n {\r\n \"id\": 86\r\n },\r\n {\r\n \"id\": 85\r\n },\r\n {\r\n \"id\": 84\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to invoices, trigged upon
\nInvoice created: INVOICE_CREATED
\nInvoice updated: INVOICE_UPDATED
\nInvoice deleted: INVOICE_DELETED
\nUsing the provided id, use the GetInvoie API to retrieve more data. Using the provided fees.id use the GetPeriodFees to retrieve more data
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f1fa682-5b66-4d44-8abc-0f0f09d629a5"},{"name":"Payment","id":"6207888d-1494-4ebb-89ab-93b8956abdd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727885313393,\r\n \"id\": \"214fb720-2248-44e0-9bfd-72171f9e72de\",\r\n \"signature\": \"b2fl8PdPRVsq0vre6DpdHJwHse8Ln+WlY0Vx32aKxtE=\",\r\n \"type\": \"PAYMENT_CREATED\",\r\n \"data\": {\r\n \"id\": 5,\r\n \"amount\": 300.0,\r\n \"publicNotes\": \"Sample note\",\r\n \"privateNotes\": \"Sample note\",\r\n \"paymentmethod\": {\r\n \"id\": 1,\r\n \"translation\": null,\r\n \"logOnlyPaymentMethod\": true,\r\n \"institutionId\": null\r\n },\r\n \"createdAt\": \"2024-10-02T16:08:33.387+00:00\",\r\n \"invoiceId\": 16\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to payments, trigged upon
\nPayment created: PAYMENT_CREATED
\nPayment updated: PAYMENT_UPDATED
\nPayment deleted: PAYMENT_DELETED
\nUsing the provided invoiceId, use the GetInvoice API to retrieve more data. Using the provided paymentmethod.id use the GetPaymentMethods to retrieve more data
\nstatus:
VALID: 1
INVALID: 2
PENDING: 3
REFUNDED: 4
Webhook related to admission forms, trigged upon
\nForm created: ADMISSION_FORM_CREATED
\nForm updated: ADMISSION_FORM_UPDATED
\nForm deleted: ADMISSION_FORM_DELETED
\nUsing the provided id, use the GetAdmissionForm API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"712a5b18-912e-4118-8eeb-5521f7afc743"},{"name":"Admission Application","id":"2af19b09-2a80-43c6-a9ec-a0c49f8e19ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727885988419,\r\n \"id\": \"dcba9199-0860-4324-8927-17df766a290e\",\r\n \"signature\": \"ssw0fpOJXiij/MRjaZfjSG8Toacmfr8UVKPa5JOKHDs=\",\r\n \"type\": \"ADMISSION_APPLICATION_CREATED\",\r\n \"data\": {\r\n \"id\": 106,\r\n \"email\": \"test@test.com\",\r\n \"createdAt\": \"2024-10-02T16:19:48.412+00:00\",\r\n \"status\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to admission applicatons, trigged upon
\nApplication created: ADMISSION_APPLICATION_CREATED
\nApplication updated: ADMISSION_APPLICATION_UPDATED
\nApplication deleted: ADMISSION_APPLICATION_DELETED
\nUsing the provided id, use the GetAdmissionApplications API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"2af19b09-2a80-43c6-a9ec-a0c49f8e19ee"},{"name":"Attendance","id":"7972f563-4a7c-4889-b19d-99072e881597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant\": \"my-school\",\r\n \"timestamp\": 1727885988419,\r\n \"id\": \"dcba9199-0860-4324-8927-17df766a290e\",\r\n \"signature\": \"ssw0fpOJXiij/MRjaZfjSG8Toacmfr8UVKPa5JOKHDs=\",\r\n \"type\": \"ATTENDANCE_CREATED\",\r\n \"data\": {\r\n \"id\": 52,\r\n \"type\": \"SESSION\",\r\n \"comment\": \"sample comment\",\r\n \"statusId\": 5,\r\n \"studentPeriodId\": 4,\r\n \"classId\": 34,\r\n \"courseId\": 40,\r\n \"date\": \"2025-06-19\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url","description":"Webhook related to admission applicatons, trigged upon
\nAttendance created: ATTENDANCE_CREATED
\nAttendance updated: ATTENDANCE_UPDATED
\nAttendance deleted: ATTENDANCE_DELETED
\nUsing the provided id, use the GetAttendanceStatuses, Students and Curriculum API to retrieve more data.
\n","urlObject":{"protocol":"https","host":["your-webhook-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"7972f563-4a7c-4889-b19d-99072e881597"}],"id":"e2eacde4-c971-4c25-8052-20a4cf61d673","description":"This API provides webhooks to notify external systems upon certain events. The event data is represented by the JSON payload included in the request body. Optionally, the outgoing request can use Basic Authentication for security. Additionally, each request may contain a HMAC hash for request validation. Finally, this API is supplementary to the DreamClass API, meaning that the entities returned by this API can be used as input to the DreamClass API to retrieve more data.
\nIn the DreamClass app, under Settings > Integrations you can configure the webhooks functionality
\nURL: The (http/https) url that will be used for the outgoing requests.
Username / Password: Optionally, set the Basic Authentication credentials for the outgoing requests.
Secret: Optionaly, set the HMAC key to be used for the signature generation.
Events: Select the events that should trigger a webhook.
Each request contains a signature attribute, which includes the hashed value of the request ID calculated using HMAC with the specified secret key. The server should validate this signature to ensure the request's integrity.
HMAC Algorithm: HmacSHA256
\nKey Encoding: Base64
\n{\n \"tenant\":\"my-school\",\n \"timestamp\":1727862002901,\n \"id\":\"b3e6fa78-8672-4e8b-8431-7eebdabd25a2\",\n \"signature\":\"nGq8sspzZVWObaR4zUOLyQ29m/IBxxD716hKx5298No=\",\n \"type\":\"STUDENT_PERIOD_CREATED\",\n \"data\":{\n \"id\":32,\n \"active\":true,\n \"studentId\":76,\n \"addedAt\":\"2024-10-02T09:40:02.179+00:00\"\n }\n}\n\nid: The ID of the request.
\nsignature: The HMAC hash of the ID.
\ntype: The event type.
\ntenant: The DreamClass domain.
\ntimestamp: The timestamp of the request.
\ndata: A JSON document that contais event data.
\nThe response to the webhook should be HTTP 200; otherwise, it will be marked as failed. The HTTP request must be completed within 10 seconds. Failed request are retried 3 times before being discarded.
\n","_postman_id":"e2eacde4-c971-4c25-8052-20a4cf61d673"}],"event":[{"listen":"prerequest","script":{"id":"bc230150-f08e-44ec-b8db-8ad5718c0804","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3e9976d-f250-429d-9e08-451b24887230","type":"text/javascript","exec":[""]}}],"variable":[{"key":"FormGUID","value":"FAyNIt"},{"key":"InvoiceId","value":"1"},{"key":"schoolPeriodId","value":"2","disabled":true},{"key":"studentName","value":"test"},{"key":"nameOrEmail","value":"test","disabled":true},{"value":"","type":"string"},{"key":"feesId","value":"31"}]}