Get Registration Setup Mass Create

GET

https://app.schoolset.io/app/api/v2/registration/setup/mass-create/:year_id/:last_year_id

GET

/app/api/v2/registration/setup/mass-create/:year_id/:last_year_id

1 curl https://app.schoolset.io/app/api/v2/registration/setup/mass-create/year_id/last_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 for the academic year.",
4   "data": {
5     "system": [
6       {
7         "id": 101,
8         "batch_id": 2023,
9         "type": "document",
10         "name": "Birth Certificate",
11         "description": "Certified copy of the student's birth certificate.",
12         "form_id": 15,
13         "requirement_details": {
14           "format": "PDF or JPEG",
15           "max_size_mb": 5,
16           "mandatory": true
17         },
18         "is_required": true,
19         "is_public": true,
20         "is_editable": false,
21         "relates_to": "student",
22         "sort_order": 1,
23         "attachments": [
24           {
25             "id": 501,
26             "file_hash": "a1b2c3d4e5f67890",
27             "file_name": "birth_certificate_2023.pdf",
28             "file_original_name": "birth_certificate_original.pdf",
29             "file_mime_type": "application/pdf",
30             "caption": "Official birth certificate",
31             "url": "https://app.schoolset.io/files/birth_certificate_2023.pdf",
32             "file_size": 450000,
33             "created_by": "admin_user",
34             "created_at": "2023-07-01T09:15:00Z",
35             "updated_at": "2023-07-01T09:15:00Z",
36             "related_to": "system_requirement",
37             "model_name": "RequirementAttachment",
38             "model_id": 101
39           }
40         ],
41         "document_templates": [
42           {}
43         ],
44         "created_by_user_id": 12,
45         "created_at": "2023-06-15T08:00:00Z",
46         "updated_at": "2023-06-20T10:30:00Z"
47       }
48     ],
49     "file": [
50       {
51         "id": 102,
52         "batch_id": 2023,
53         "type": "form",
54         "name": "Student Enrollment Form",
55         "description": "Form to be filled by parents for student enrollment.",
56         "form_id": 16,
57         "requirement_details": {
58           "fields": [
59             "student_name",
60             "date_of_birth",
61             "parent_contact"
62           ],
63           "submission_deadline": "2023-08-31"
64         },
65         "is_required": true,
66         "is_public": false,
67         "is_editable": true,
68         "relates_to": "enrollment",
69         "sort_order": 2,
70         "attachments": [
71           {
72             "id": 502,
73             "file_hash": "f1e2d3c4b5a69788",
74             "file_name": "enrollment_form_2023.pdf",
75             "file_original_name": "enrollment_form_original.pdf",
76             "file_mime_type": "application/pdf",
77             "caption": "Enrollment form template",
78             "url": "https://app.schoolset.io/files/enrollment_form_2023.pdf",
79             "file_size": 300000,
80             "created_by": "form_manager",
81             "created_at": "2023-06-10T11:00:00Z",
82             "updated_at": "2023-06-10T11:00:00Z",
83             "related_to": "file_requirement",
84             "model_name": "RequirementAttachment",
85             "model_id": 102
86           }
87         ],
88         "document_templates": [
89           {}
90         ],
91         "created_by_user_id": 15,
92         "created_at": "2023-06-12T07:45:00Z",
93         "updated_at": "2023-06-18T14:20:00Z"
94       }
95     ],
96     "document_template": [
97       {
98         "id": 103,
99         "batch_id": 2023,
100         "type": "template",
101         "name": "Admission Letter",
102         "description": "Template for admission confirmation letter.",
103         "form_id": 17,
104         "requirement_details": {
105           "template_format": "DOCX",
106           "editable_fields": [
107             "student_name",
108             "admission_date"
109           ]
110         },
111         "is_required": true,
112         "is_public": true,
113         "is_editable": true,
114         "relates_to": "admission",
115         "sort_order": 3,
116         "attachments": [
117           {
118             "id": 503,
119             "file_hash": "9a8b7c6d5e4f3210",
120             "file_name": "admission_letter_template.docx",
121             "file_original_name": "admission_letter_template_original.docx",
122             "file_mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
123             "caption": "Editable admission letter template",
124             "url": "https://app.schoolset.io/files/admission_letter_template.docx",
125             "file_size": 120000,
126             "created_by": "template_admin",
127             "created_at": "2023-06-20T13:00:00Z",
128             "updated_at": "2023-06-22T09:30:00Z",
129             "related_to": "document_template",
130             "model_name": "RequirementAttachment",
131             "model_id": 103
132           }
133         ],
134         "document_templates": [
135           {}
136         ],
137         "created_by_user_id": 18,
138         "created_at": "2023-06-19T10:00:00Z",
139         "updated_at": "2023-06-21T15:45:00Z"
140       }
141     ],
142     "form": [
143       {
144         "id": 104,
145         "batch_id": 2023,
146         "type": "online_form",
147         "name": "Medical Information Form",
148         "description": "Form to collect student medical information.",
149         "form_id": 18,
150         "requirement_details": {
151           "fields": [
152             "allergies",
153             "medications",
154             "emergency_contact"
155           ],
156           "confidential": true
157         },
158         "is_required": true,
159         "is_public": false,
160         "is_editable": true,
161         "relates_to": "health",
162         "sort_order": 4,
163         "attachments": [
164           {
165             "id": 504,
166             "file_hash": "1234abcd5678efgh",
167             "file_name": "medical_info_form.pdf",
168             "file_original_name": "medical_info_form_original.pdf",
169             "file_mime_type": "application/pdf",
170             "caption": "Medical info form template",
171             "url": "https://app.schoolset.io/files/medical_info_form.pdf",
172             "file_size": 250000,
173             "created_by": "health_officer",
174             "created_at": "2023-06-25T08:30:00Z",
175             "updated_at": "2023-06-25T08:30:00Z",
176             "related_to": "form_requirement",
177             "model_name": "RequirementAttachment",
178             "model_id": 104
179           }
180         ],
181         "document_templates": [
182           {}
183         ],
184         "created_by_user_id": 20,
185         "created_at": "2023-06-24T09:00:00Z",
186         "updated_at": "2023-06-26T11:15:00Z"
187       }
188     ],
189     "stages": [
190       {
191         "id": 301,
192         "batch_id": 2023,
193         "registration_status_id": 5,
194         "student_status_id": 3,
195         "academic_year": {
196           "id": 2023,
197           "title": "Academic Year 2023-2024",
198           "slug": "2023-2024",
199           "start_at": "2023-09-01T00:00:00Z",
200           "end_at": "2024-06-30T23:59:59Z",
201           "active": true,
202           "is_visible": true,
203           "created_by": "system_admin",
204           "created_at": "2023-01-15T12:00:00Z",
205           "updated_at": "2023-05-10T14:00:00Z"
206         },
207         "registration_status": {
208           "id": 5,
209           "name": "Open",
210           "description": "Registration is currently open for new students."
211         },
212         "student_status": {
213           "id": 3,
214           "name": "Prospective",
215           "description": "Student is a prospective enrollee."
216         }
217       }
218     ],
219     "registration_active": true
220   }
221 }

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

last_year_idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject