Get Registration Setup Mapping

GET

https://app.schoolset.io/app/api/v2/registration/setup/mapping/:year_id

GET

/app/api/v2/registration/setup/mapping/:year_id

1 curl https://app.schoolset.io/app/api/v2/registration/setup/mapping/year_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Registration setup requirements retrieved successfully.",
4   "data": [
5     {
6       "id": 101,
7       "batch_id": 2023,
8       "registration_status_id": 3,
9       "student_status_id": 2,
10       "academic_year": {
11         "id": 2023,
12         "title": "Academic Year 2023-2024",
13         "slug": "academic-year-2023-2024",
14         "start_at": "2023-08-01T00:00:00Z",
15         "end_at": "2024-07-31T23:59:59Z",
16         "active": true,
17         "is_visible": true,
18         "created_by": "admin_user",
19         "created_at": "2023-01-15T09:30:00Z",
20         "updated_at": "2023-06-10T14:45:00Z"
21       },
22       "registration_status": {
23         "id": 3,
24         "name": "Open",
25         "description": "Registration is currently open for this batch."
26       },
27       "student_status": {
28         "id": 2,
29         "name": "Enrolled",
30         "description": "Student is currently enrolled."
31       }
32     }
33   ]
34 }

Creates, updates, or returns registration setup requirements for the selected academic year.

Authentication

AuthorizationBearer

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

Path parameters

year_idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

datalist of objects