Skip to main content
PATCH
/
api
/
v1
/
school
/
admissions
/
{id}
Update admissions partial
curl --request PATCH \
  --url https://api.example.com/api/v1/school/admissions/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "birth_number": "<string>",
  "gender": "Male",
  "phone": "<string>",
  "term": "1",
  "admission_number": "<string>",
  "church": "<string>",
  "admission_year": "<string>",
  "previous_school": "<string>",
  "units": 100,
  "form": "<string>",
  "health_condition": "<string>",
  "date_of_admission": "2023-12-25",
  "address": "<string>",
  "status": "Boarding",
  "is_deleted": true,
  "guardian_name": "<string>",
  "relationship": "<string>"
}
'
{
  "first_name": "<string>",
  "last_name": "<string>",
  "birth_number": "<string>",
  "gender": "Male",
  "phone": "<string>",
  "admission_number": "<string>",
  "church": "<string>",
  "admission_year": "<string>",
  "previous_school": "<string>",
  "form": "<string>",
  "date_of_admission": "2023-12-25",
  "address": "<string>",
  "status": "Boarding",
  "guardian_name": "<string>",
  "relationship": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date_of_birth": "2023-12-25",
  "term": "1",
  "units": 100,
  "health_condition": "<string>",
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this student admission.

Body

Auto-populate created_by from request.user when available.

​
first_name
string
Required string length: 1 - 255
​
last_name
string
Required string length: 1 - 255
​
date_of_birth
string<date> | null
​
birth_number
string | null
Maximum string length: 255
​
gender
enum<string>
  • Male - Male
  • Female - Female
Available options:
Male,
Female
​
phone
string
Required string length: 1 - 255
​
term
enum<string>
  • 1 - 1
  • 2 - 2
  • 3 - 3
Available options:
1,
2,
3
​
admission_number
string
Required string length: 1 - 255
​
church
string
Required string length: 1 - 255
​
admission_year
string
Required string length: 1 - 255
​
previous_school
string
Required string length: 1 - 255
​
units
integer | null
Required range: 0 <= x <= 200
​
form
string
Required string length: 1 - 255
​
health_condition
string | null
​
date_of_admission
string<date>
​
address
string
Minimum string length: 1
​
status
enum<string>
  • Boarding - Boarding
  • Day - Day
Available options:
Boarding,
Day
​
is_deleted
boolean
​
guardian_name
string
Required string length: 1 - 255
​
relationship
string
Required string length: 1 - 255

Response

200 - application/json

Auto-populate created_by from request.user when available.

​
first_name
string
required
Maximum string length: 255
​
last_name
string
required
Maximum string length: 255
​
birth_number
string | null
required
Maximum string length: 255
​
gender
enum<string>
required
  • Male - Male
  • Female - Female
Available options:
Male,
Female
​
phone
string
required
Maximum string length: 255
​
admission_number
string
required
Maximum string length: 255
​
church
string
required
Maximum string length: 255
​
admission_year
string
required
Maximum string length: 255
​
previous_school
string
required
Maximum string length: 255
​
form
string
required
Maximum string length: 255
​
date_of_admission
string<date>
required
​
address
string
required
​
status
enum<string>
required
  • Boarding - Boarding
  • Day - Day
Available options:
Boarding,
Day
​
guardian_name
string
required
Maximum string length: 255
​
relationship
string
required
Maximum string length: 255
​
id
string<uuid>
​
date_of_birth
string<date> | null
​
term
enum<string>
  • 1 - 1
  • 2 - 2
  • 3 - 3
Available options:
1,
2,
3
​
units
integer | null
Required range: 0 <= x <= 200
​
health_condition
string | null
​
is_deleted
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>