GetCustomFields

GET

/dreamclassapi/v1/students/custom-fields

GET

/dreamclassapi/v1/students/custom-fields

1 curl https://https//https/dreamclassapi/v1/students/custom-fields \
2      -H "tenant: {{tenant}}" \
3      -H "schoolCode: {{schoolCode}}" \
4      -H "Content-Type: application/json"

200Students_GetCustomFields_example

1 [
2   {
3     "id": 15,
4     "formField": {
5       "row": "1",
6       "type": "text",
7       "label": "Passport Number",
8       "selectOptions": {},
9       "hiddenToStudents": false,
10       "hiddenToTeachers": false,
11       "hiddenToGuardians": false,
12       "editableByStudents": true,
13       "editableByTeachers": true,
14       "editableByGuardians": true
15     },
16     "entityType": "STUDENT",
17     "institution": {
18       "id": 42
19     }
20   },
21   {
22     "id": 202,
23     "formField": {
24       "row": "2",
25       "type": "custom-field-select",
26       "label": "Enrollment Type",
27       "selectOptions": {
28         "options": [
29           {
30             "name": "Full time"
31           },
32           {
33             "name": "Part time"
34           },
35           {
36             "name": "Exchange"
37           }
38         ]
39       },
40       "hiddenToStudents": false,
41       "hiddenToTeachers": false,
42       "hiddenToGuardians": false,
43       "editableByStudents": true,
44       "editableByTeachers": true,
45       "editableByGuardians": true
46     },
47     "entityType": "STUDENT",
48     "institution": {
49       "id": 42
50     }
51   }
52 ]

Get a list of the available custom fields for students

Response

idinteger

formFieldobject

entityTypestring

institutionobject

Headers

Response