Get Structure Relations School Grade | SchoolSet

curl https://app.schoolset.io/app/api/v2/school/settings/structure/relations/school-grade/attach/year_id/grade_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Structure relation successfully attached to the school grade.",
  "data": [
    {
      "academic_year": {
        "id": 2024,
        "title": "Academic Year 2024-2025",
        "slug": "academic-year-2024-2025",
        "start_at": "2024-09-01T00:00:00Z",
        "end_at": "2025-06-30T23:59:59Z",
        "active": true,
        "is_visible": true,
        "created_by": "admin_user",
        "created_at": "2023-12-15T10:00:00Z",
        "updated_at": "2024-01-10T15:30:00Z"
      },
      "tree": {
        "id": 15,
        "name": "Grade 10 - Science Stream",
        "type": "grade",
        "children": [
          {
            "id": 101,
            "name": "Physics",
            "type": "subject"
          },
          {
            "id": 102,
            "name": "Chemistry",
            "type": "subject"
          }
        ],
        "permission_to_delete": false,
        "created_at": "2024-02-01T08:45:00Z",
        "updated_at": "2024-04-20T12:00:00Z"
      }
    }
  ]
}

Attaches the selected structure relation in the school structure.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

year_idstringRequired

grade_idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects