Get Registration Setup

GET

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

GET

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

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Registration setup retrieved successfully for the academic year.",
4   "data": {
5     "system": [
6       {
7         "id": 101,
8         "batch_id": 2023,
9         "type": "document",
10         "name": "Proof of Residency",
11         "description": "Submit a valid proof of residency document.",
12         "form_id": 15,
13         "requirement_details": {
14           "accepted_formats": [
15             "pdf",
16             "jpg",
17             "png"
18           ],
19           "max_file_size_mb": 5
20         },
21         "is_required": true,
22         "is_public": true,
23         "is_editable": false,
24         "relates_to": "student_address",
25         "sort_order": 1,
26         "attachments": [
27           {
28             "id": 501,
29             "file_hash": "a1b2c3d4e5f67890",
30             "file_name": "residency_requirements.pdf",
31             "file_original_name": "Residency_Requirements_2024.pdf",
32             "file_mime_type": "application/pdf",
33             "caption": "Residency Document Guidelines",
34             "url": "https://app.schoolset.io/files/residency_requirements.pdf",
35             "file_size": 450000,
36             "created_by": "admin_user",
37             "created_at": "2023-11-01T09:00:00Z",
38             "updated_at": "2023-11-15T10:30:00Z",
39             "related_to": "system_requirement",
40             "model_name": "RequirementAttachment",
41             "model_id": 101
42           }
43         ],
44         "document_templates": [
45           {
46             "template_name": "Residency Proof Template",
47             "template_version": "v1.2"
48           }
49         ],
50         "created_by_user_id": 12,
51         "created_at": "2023-10-20T08:45:00Z",
52         "updated_at": "2023-11-10T14:20:00Z"
53       }
54     ],
55     "file": [
56       {
57         "id": 202,
58         "batch_id": 2023,
59         "type": "upload",
60         "name": "Student Photo",
61         "description": "Upload a recent passport-sized photograph.",
62         "form_id": 16,
63         "requirement_details": {
64           "max_dimensions": "600x600",
65           "accepted_formats": [
66             "jpg",
67             "png"
68           ],
69           "max_file_size_mb": 2
70         },
71         "is_required": true,
72         "is_public": false,
73         "is_editable": true,
74         "relates_to": "student_profile",
75         "sort_order": 2,
76         "attachments": [
77           {
78             "id": 502,
79             "file_hash": "f1e2d3c4b5a69788",
80             "file_name": "photo_guidelines.pdf",
81             "file_original_name": "Photo_Guidelines_2024.pdf",
82             "file_mime_type": "application/pdf",
83             "caption": "Photo Upload Instructions",
84             "url": "https://app.schoolset.io/files/photo_guidelines.pdf",
85             "file_size": 300000,
86             "created_by": "admin_user",
87             "created_at": "2023-11-05T11:00:00Z",
88             "updated_at": "2023-11-12T12:00:00Z",
89             "related_to": "file_requirement",
90             "model_name": "RequirementAttachment",
91             "model_id": 202
92           }
93         ],
94         "document_templates": [
95           {
96             "template_name": "Photo Upload Template",
97             "template_version": "v1.0"
98           }
99         ],
100         "created_by_user_id": 15,
101         "created_at": "2023-10-25T10:00:00Z",
102         "updated_at": "2023-11-11T13:15:00Z"
103       }
104     ],
105     "document_template": [
106       {
107         "id": 303,
108         "batch_id": 2023,
109         "type": "form",
110         "name": "Medical Information Form",
111         "description": "Form to collect student medical information.",
112         "form_id": 20,
113         "requirement_details": {
114           "fields": [
115             "allergies",
116             "medications",
117             "emergency_contact"
118           ],
119           "mandatory_fields": [
120             "emergency_contact"
121           ]
122         },
123         "is_required": true,
124         "is_public": true,
125         "is_editable": true,
126         "relates_to": "student_health",
127         "sort_order": 3,
128         "attachments": [
129           {
130             "id": 503,
131             "file_hash": "9a8b7c6d5e4f3210",
132             "file_name": "medical_form_template.docx",
133             "file_original_name": "Medical_Form_Template_2024.docx",
134             "file_mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
135             "caption": "Medical Form Template",
136             "url": "https://app.schoolset.io/files/medical_form_template.docx",
137             "file_size": 120000,
138             "created_by": "health_officer",
139             "created_at": "2023-10-30T09:30:00Z",
140             "updated_at": "2023-11-08T15:45:00Z",
141             "related_to": "document_template",
142             "model_name": "RequirementAttachment",
143             "model_id": 303
144           }
145         ],
146         "document_templates": [
147           {
148             "template_name": "Health Form v2",
149             "template_version": "v2.0"
150           }
151         ],
152         "created_by_user_id": 20,
153         "created_at": "2023-10-22T07:50:00Z",
154         "updated_at": "2023-11-09T16:00:00Z"
155       }
156     ],
157     "form": [
158       {
159         "id": 404,
160         "batch_id": 2023,
161         "type": "online_form",
162         "name": "Parent Consent Form",
163         "description": "Online form for parental consent.",
164         "form_id": 25,
165         "requirement_details": {
166           "fields": [
167             "parent_name",
168             "signature",
169             "date"
170           ],
171           "mandatory_fields": [
172             "signature"
173           ]
174         },
175         "is_required": true,
176         "is_public": true,
177         "is_editable": true,
178         "relates_to": "parental_consent",
179         "sort_order": 4,
180         "attachments": [
181           {
182             "id": 504,
183             "file_hash": "1234abcd5678efgh",
184             "file_name": "consent_form_instructions.pdf",
185             "file_original_name": "Consent_Form_Instructions_2024.pdf",
186             "file_mime_type": "application/pdf",
187             "caption": "Instructions for Consent Form",
188             "url": "https://app.schoolset.io/files/consent_form_instructions.pdf",
189             "file_size": 250000,
190             "created_by": "admin_user",
191             "created_at": "2023-11-02T08:00:00Z",
192             "updated_at": "2023-11-14T09:30:00Z",
193             "related_to": "form_requirement",
194             "model_name": "RequirementAttachment",
195             "model_id": 404
196           }
197         ],
198         "document_templates": [
199           {
200             "template_name": "Consent Form Template",
201             "template_version": "v1.1"
202           }
203         ],
204         "created_by_user_id": 18,
205         "created_at": "2023-10-28T11:20:00Z",
206         "updated_at": "2023-11-13T14:10:00Z"
207       }
208     ],
209     "stages": [
210       {
211         "id": 1,
212         "batch_id": 2023,
213         "registration_status_id": 3,
214         "student_status_id": 2,
215         "academic_year": {
216           "id": 2023,
217           "title": "Academic Year 2023-2024",
218           "slug": "2023-2024",
219           "start_at": "2023-09-01T00:00:00Z",
220           "end_at": "2024-06-30T23:59:59Z",
221           "active": true,
222           "is_visible": true,
223           "created_by": "system_admin",
224           "created_at": "2023-01-15T12:00:00Z",
225           "updated_at": "2023-08-01T09:00:00Z"
226         },
227         "registration_status": {
228           "id": 3,
229           "name": "Documents Submitted",
230           "description": "Student has submitted all required documents."
231         },
232         "student_status": {
233           "id": 2,
234           "name": "Enrolled",
235           "description": "Student is enrolled for the academic year."
236         }
237       }
238     ],
239     "registration_active": true
240   }
241 }

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

dataobject