ConnectGuardian | DreamClass

curl -X POST https://api.dreamclass.io/dreamclassapi/v1/students/guardian/connect \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "student": {
    "id": 119
  },
  "guardian": {
    "id": 252,
    "email": "test@test.com",
    "firstname": "firstname",
    "lastname": "lastname",
    "gender": "Male",
    "country": "",
    "city": ""
  },
  "relation": {
    "id": 2
  }
}'

{
  "student": {
    "id": 119
  },
  "guardian": {
    "id": 252,
    "email": "test@test.com",
    "firstname": "firstname",
    "lastname": "lastname",
    "gender": "Male",
    "country": "",
    "city": ""
  },
  "relation": {
    "id": 2
  }
}

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.

Headers

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