ConnectGuardian

POST

/dreamclassapi/v1/students/guardian/connect

POST

/dreamclassapi/v1/students/guardian/connect

1 curl -X POST https://https//https/dreamclassapi/v1/students/guardian/connect \
2      -H "tenant: {{tenant}}" \
3      -H "schoolCode: {{schoolCode}}" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "student": {
7     "id": 119
8   },
9   "guardian": {
10     "id": 252,
11     "email": "test@test.com",
12     "firstname": "firstname",
13     "lastname": "lastname",
14     "gender": "Male",
15     "country": "",
16     "city": ""
17   },
18   "relation": {
19     "id": 2
20   }
21 }'

200Students_ConnectGuardian_example

1 {
2   "student": {
3     "id": 119
4   },
5   "guardian": {
6     "id": 252,
7     "email": "test@test.com",
8     "firstname": "firstname",
9     "lastname": "lastname",
10     "gender": "Male",
11     "country": "",
12     "city": ""
13   },
14   "relation": {
15     "id": 2
16   }
17 }

Connect a Guardian to a Student Record

If the provided guardian ID is empty or does not exist, a new guardian record is created before it is connected to the student.

Request

This endpoint expects an object.

studentobjectRequired

guardianobjectRequired

relationobjectRequired

Response headers

ExpiresstringOptional

Cache-ControlstringOptional

Access-Control-Allow-HeadersstringOptional

X-XSS-ProtectionstringOptional

PragmastringOptional

Access-Control-Allow-MethodsstringOptional

X-Frame-OptionsstringOptional

Access-Control-Expose-HeadersstringOptional

Access-Control-Allow-OriginstringOptional

Access-Control-Allow-CredentialsstringOptional

X-Content-Type-OptionsstringOptional

Access-Control-Max-AgestringOptional

Response

studentobject

guardianobject

relationobject