Get Structure Relations Department Department

GET

https://app.schoolset.io/app/api/v2/school/settings/structure/relations/department-department/attach/:year_id/:first_department_id/:second_department_id/:main_relation

GET

/app/api/v2/school/settings/structure/relations/department-department/attach/:year_id/:first_department_id/:second_department_id/:main_relation

1 curl https://app.schoolset.io/app/api/v2/school/settings/structure/relations/department-department/attach/year_id/first_department_id/second_department_id/main_relation \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Department relation attached successfully.",
4   "data": [
5     {
6       "academic_year": {
7         "id": 2024,
8         "title": "2024-2025 Academic Year",
9         "slug": "2024-2025",
10         "start_at": "2024-09-01T00:00:00Z",
11         "end_at": "2025-06-30T23:59:59Z",
12         "active": true,
13         "is_visible": true,
14         "created_by": "admin_user",
15         "created_at": "2023-05-15T10:20:30Z",
16         "updated_at": "2024-01-10T08:15:00Z"
17       },
18       "tree": {
19         "id": 12,
20         "name": "Science Department",
21         "type": "department",
22         "children": [
23           {
24             "id": 34,
25             "name": "Physics Division",
26             "type": "division"
27           }
28         ],
29         "permission_to_delete": false,
30         "created_at": "2022-08-01T09:00:00Z",
31         "updated_at": "2024-04-20T14:45:00Z"
32       }
33     }
34   ]
35 }

Attaches the selected department 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

first_department_idstringRequired

second_department_idstringRequired

main_relationstringRequired

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects