Create student family

POST

https://app.schoolset.io/app/api/v1/family/create

POST

/app/api/v1/family/create

1 curl -X POST https://app.schoolset.io/app/api/v1/family/create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Family name"
6 }'

200Successful

1 {
2   "status": "success",
3   "message": "string",
4   "data": {
5     "id": 1,
6     "name": "string",
7     "lastname": "string",
8     "lastname_hebrew": "string",
9     "home_phone": "string",
10     "cell_phone": "string",
11     "email": "string",
12     "addresses": [
13       {
14         "id": 1,
15         "components": [
16           null
17         ],
18         "splitted": [
19           null
20         ],
21         "formatted": "string",
22         "longitude": 1.1,
23         "latitude": 1.1,
24         "tag": "string"
25       }
26     ],
27     "description": "string",
28     "statement_account_balance": 1.1,
29     "statement_account_due": 1.1,
30     "parents": [
31       {
32         "id": 1,
33         "firstname": "string",
34         "firstname_hebrew": "string",
35         "lastname": "string",
36         "lastname_hebrew": "string",
37         "dob": "string",
38         "dob_hebrew": "string",
39         "full_name": "string",
40         "hebrew_full_name": "string",
41         "type": "string",
42         "parent_student_type_id": 1,
43         "marital_status": {
44           "id": 1,
45           "title": "string",
46           "sys_name": "string"
47         },
48         "marital_status_id": 1,
49         "email": "string",
50         "home_phone": "string",
51         "cell_phone": "string",
52         "work_phone": "string",
53         "maiden_name": "string",
54         "address": "string",
55         "city": "string",
56         "state": "string",
57         "country": "string",
58         "zip": "string",
59         "user_id": 1,
60         "verify_sms": true,
61         "family_student_id": 1,
62         "donor_id": 1,
63         "addresses": [
64           {
65             "id": 1,
66             "components": [
67               null
68             ],
69             "splitted": [
70               null
71             ],
72             "formatted": "string",
73             "longitude": 1.1,
74             "latitude": 1.1,
75             "tag": "string"
76           }
77         ],
78         "prefix": "string",
79         "suffix": "string",
80         "hebrew_prefix": "string",
81         "hebrew_suffix": "string",
82         "job_title": "string",
83         "occupation": "string",
84         "employer": "string",
85         "created_by": "string",
86         "created_at": "string",
87         "updated_at": "string"
88       }
89     ],
90     "students": [
91       {
92         "id": 1,
93         "firstname": "string",
94         "lastname": "string",
95         "full_name": "string",
96         "email": "string",
97         "academ_year_id": 1,
98         "teacher_id": 1,
99         "dob": "string",
100         "dob_hebrew": "string",
101         "gender": "string",
102         "address": "string",
103         "city": "string",
104         "state": "string",
105         "country": "string",
106         "zip": "string",
107         "phone": "string",
108         "school_classes": [
109           {
110             "id": 1,
111             "name": "string",
112             "is_active": true,
113             "level": 1
114           }
115         ],
116         "school_grades": [
117           {
118             "id": 1,
119             "name": "string",
120             "level": 1,
121             "batch_id": 1,
122             "is_current": true
123           }
124         ],
125         "statuses": [
126           {
127             "id": 1,
128             "title": "string",
129             "description": "string",
130             "order": 1,
131             "batch_id": 1
132           }
133         ],
134         "school_departments": [
135           null
136         ],
137         "family_student_id": 1,
138         "photo_file_manager_id": 1,
139         "photo_url": "string",
140         "addresses": [
141           {
142             "id": 1,
143             "components": [
144               null
145             ],
146             "splitted": [
147               null
148             ],
149             "formatted": "string",
150             "longitude": 1.1,
151             "latitude": 1.1,
152             "tag": "string"
153           }
154         ],
155         "firstname_hebrew": "string",
156         "lastname_hebrew": "string",
157         "gov_id": "string",
158         "legal_name": "string",
159         "kodesh_name": "string",
160         "created_by": "string",
161         "created_at": "string",
162         "updated_at": "string"
163       }
164     ],
165     "relatives": [
166       {
167         "id": 1,
168         "firstname": "string",
169         "lastname": "string",
170         "firstname_hebrew": "string",
171         "lastname_hebrew": "string",
172         "email": "string",
173         "home_phone": "string",
174         "cell_phone": "string",
175         "address": "string",
176         "city": "string",
177         "state": "string",
178         "country": "string",
179         "zip": "string",
180         "user_id": 1,
181         "verify_sms": true,
182         "family_student_id": 1,
183         "parent_student_type_id": 1,
184         "type": "string",
185         "addresses": [
186           {
187             "id": 1,
188             "components": [
189               null
190             ],
191             "splitted": [
192               null
193             ],
194             "formatted": "string",
195             "longitude": 1.1,
196             "latitude": 1.1,
197             "tag": "string"
198           }
199         ],
200         "created_by": "string",
201         "created_at": "string",
202         "updated_at": "string"
203       }
204     ],
205     "emergency_contacts": [
206       {
207         "id": 1,
208         "firstname": "string",
209         "firstname_hebrew": "string",
210         "lastname": "string",
211         "lastname_hebrew": "string",
212         "description": "string",
213         "email": "string",
214         "home_phone": "string",
215         "cell_phone": "string",
216         "work_phone": "string",
217         "emergency_contact_type_id": 1,
218         "relation": "string",
219         "address": "string",
220         "city": "string",
221         "state": "string",
222         "country": "string",
223         "zip": "string",
224         "user_id": 1,
225         "verify_sms": true,
226         "family_student_id": 1,
227         "addresses": [
228           {
229             "id": 1,
230             "components": [
231               null
232             ],
233             "splitted": [
234               null
235             ],
236             "formatted": "string",
237             "longitude": 1.1,
238             "latitude": 1.1,
239             "tag": "string"
240           }
241         ]
242       }
243     ]
244   }
245 }

Creates family data from submitted details.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestring or nullRequired

Family name.

lastname_hebrewstring or nullOptional

lastname hebrew display value.

descriptionstring or nullOptional

Family description.

Response

JSON response payload for family creation.

statusenum

Allowed values:

messagestring

dataobject