Digital Attendance Application Kenya

users

/api/v1/users/

GET POST OPTIONS

List Create System Users

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsSystemAdmin	The request is authenticated as a user, or is a read-only request.

Param name	Description
password	Password
last_login	Last Login
is_superuser	Is Superuser
groups	Groups
user_permissions	User Permissions
username	Username
first_name	First Name
last_name	Last Name
email	Email
is_staff	Is Staff
is_active	Is Active
date_joined	Date Joined
last_activity	Last Activity
role	Role
phone	Phone
google_profile_image	Google Profile Image
dob	Dob
bio	Bio
gender	Gender
allow_notification	Allow Notification
confirm_code	Confirm Code
reset_code	Reset Code
old_password	Old Password
changed_password	Changed Password
verified	Verified
dummy	Dummy
filter_args	Filter Args
is_partner	Is Partner
search	Search

Request Fields:

{

first_name: CharField,
dummy: BooleanField,
filter_args: CharField,
last_name: CharField,
username: CharField, Required Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

password: CharField, Required

}

Response Fields:

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

/api/v1/users/logs/

GET OPTIONS

List Activity Logs

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
user	User
request_url	Request Url
request_method	Request Method
response_code	Response Code
datetime	Datetime
device	Device
browser	Browser
os	Os
extra_data	Extra Data
ip_address	Ip Address
search	Search

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,

user: MyUserSerializer,

Item structure

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

request_url: URLField,
request_method: CharField,
response_code: CharField,
datetime: DateTimeField,
device: CharField,
browser: CharField,
os: CharField,
extra_data: CharField,
ip_address: IPAddressField

}

/api/v1/users/logs/export/

GET OPTIONS

Export Activity Logs

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
user	User
request_url	Request Url
request_method	Request Method
response_code	Response Code
datetime	Datetime
device	Device
browser	Browser
os	Os
extra_data	Extra Data
ip_address	Ip Address
search	Search

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
user: StringRelatedField, Help Text
request_url: URLField,
request_method: CharField,
response_code: CharField,
datetime: DateTimeField,
device: CharField,
browser: CharField,
os: CharField,
extra_data: CharField,
ip_address: IPAddressField

}

/api/v1/users/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Client

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsSystemAdmin	The request is authenticated as a user, or is a read-only request.
IsNonDeleteTeacher	A base class from which all permission classes should inherit.

Request Fields:

{

first_name: CharField,
dummy: BooleanField,
filter_args: CharField,
last_name: CharField,
username: CharField, Required Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

password: CharField, Required

}

Response Fields:

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

/api/v1/users/me/profile/

GET PUT PATCH OPTIONS

Retrieve Client

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

first_name: CharField,
dummy: BooleanField,
filter_args: CharField,
last_name: CharField,
username: CharField, Required Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

password: CharField, Required

}

Response Fields:

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

/api/v1/users/me/change-password

PUT OPTIONS

Clients Change Password

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/users/me/resend-verification-email

POST OPTIONS

Clients Resend Confirm Email

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/users/forgot-password

POST OPTIONS

Clients Forgot Password

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

username: CharField, Required

}

Response Fields:

{

username: CharField,
detail: ReadOnlyField

}

/api/v1/users/reset-password

POST PUT PATCH OPTIONS

Clients Reset Password

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

reset_code: IntegerField, Required
new_password: CharField, Required
confirm_password: CharField Required

}

Response Fields:

{

reset_code: IntegerField,
new_password: CharField,
confirm_password: CharField

}

/api/v1/users/admin-reset-password/

PUT OPTIONS

Admin Reset Enum Password

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

username: CharField, Required
new_password: CharField Required

}

Response Fields:

{

username: CharField,
new_password: CharField

}

/api/v1/users/teacher/school-info/

GET OPTIONS

User Teacher School Info

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsNonDeleteTeacher	A base class from which all permission classes should inherit.

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
school_name: CharField,
username: CharField,
gender_name: CharField,
gender: CharField,
role: CharField,
role_name: CharField,
streams: SerializerMethodField,
teachers: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField,

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField Help Text

}

attendances

student-absent-reasons

/api/v1/attendances/student-absent-reasons/

GET POST OPTIONS

List Create Student Absent Reasons

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
student	Student
reason	Reason
date	Date
description	Description
school_id	School Id
base_class	Base Class
recorded_date	Recorded Date
start_recorded_date	Start Recorded Date
end_recorded_date	End Recorded Date
stream_id	Stream Id
sub_county_id	Sub County Id
county_id	County Id

Request Fields:

{

date: DateField, Required
description: CharField,
student: PrimaryKeyRelatedField, Required Help Text
reason: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
date: DateField,
description: CharField,
student: PrimaryKeyRelatedField, Help Text
reason: PrimaryKeyRelatedField Help Text

}

/api/v1/attendances/student-absent-reasons/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Student Absent Reason

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

date: DateField, Required
description: CharField,
student: PrimaryKeyRelatedField, Required Help Text
reason: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
date: DateField,
description: CharField,
student: PrimaryKeyRelatedField, Help Text
reason: PrimaryKeyRelatedField Help Text

}

/api/v1/attendances/

GET POST OPTIONS

List Create Attendances

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsTeacherOfTheSchool	A base class from which all permission classes should inherit.

Request Fields:

{

id: CharField, Required
date: DateTimeField, Required

status: ChoiceField,

Choices

Value	Meaning
1	Present
0	Absent

cause_of_absence: CharField,
student: PrimaryKeyRelatedField, Required Help Text
stream: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: CharField,
date: DateTimeField,

status: ChoiceField,

Choices

Value	Meaning
1	Present
0	Absent

cause_of_absence: CharField,
student: PrimaryKeyRelatedField, Help Text
stream: PrimaryKeyRelatedField Help Text

}

/api/v1/attendances/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Attendance

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

id: CharField, Required
date: DateTimeField, Required

status: ChoiceField,

Choices

Value	Meaning
1	Present
0	Absent

cause_of_absence: CharField,
student: PrimaryKeyRelatedField, Required Help Text
stream: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: CharField,
date: DateTimeField,

status: ChoiceField,

Choices

Value	Meaning
1	Present
0	Absent

cause_of_absence: CharField,
student: PrimaryKeyRelatedField, Help Text
stream: PrimaryKeyRelatedField Help Text

}

/api/v1/attendances/stats/

GET POST OPTIONS

List Dynamic Attendances Statistics

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
id	Id
student	Student
date	Date
status	Status
cause_of_absence	Cause Of Absence
stream	Stream
base_class	Base Class
start_date	Start Date
end_date	End Date
gender	Gender
learner_status	Learner Status
school	School
school_emis_code	School Emis Code
school_sub_county	School Sub County
school_county	School County
year	Year
month	Month
special_needs	Special Needs
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

{

}

Response Fields:

{

males: ReadOnlyField,
females: ReadOnlyField,
total_students: ReadOnlyField,
value: ReadOnlyField

}

/api/v1/attendances/<type>/

GET OPTIONS

List Create Attendance Statistics

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
id	Id
student	Student
date	Date
status	Status
cause_of_absence	Cause Of Absence
stream	Stream
base_class	Base Class
start_date	Start Date
end_date	End Date
gender	Gender
learner_status	Learner Status
school	School
school_emis_code	School Emis Code
school_sub_county	School Sub County
school_county	School County
year	Year
month	Month
special_needs	Special Needs
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

No input data specified

Response Fields:

{

id: CharField,
date: DateTimeField,

status: ChoiceField,

Choices

Value	Meaning
1	Present
0	Absent

cause_of_absence: CharField,
student: PrimaryKeyRelatedField, Help Text
stream: PrimaryKeyRelatedField Help Text

}

schools

/api/v1/schools/

GET POST OPTIONS

List Create Schools

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
sub_county	Sub County
name	Name
emis_code	Emis Code
phone	Phone
email	Email
school_ministry	School Ministry
founder_name	Founder Name
year_of_foundation	Year Of Foundation
ownership	Ownership
lat	Lat
lng	Lng
start_of_calendar	Start Of Calendar
end_of_calendar	End Of Calendar
active	Active
lowest_grade	Lowest Grade
highest_grade	Highest Grade
schooling	Schooling
gender	Gender
moe_id	Moe Id
moe_emis_code	Moe Emis Code
is_training_school	Is Training School

Request Fields:

{

name: CharField, Required
emis_code: CharField, Required
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
village_name: CharField,
district_name: CharField,
district: CharField,
sub_county_name: ReadOnlyField,
county: ReadOnlyField,
county_name: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
emis_code: CharField,
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

/api/v1/schools/test-report/

GET OPTIONS

Rest Report

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/schools/nemis-primary-sync/

POST OPTIONS

Moe Test

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/schools/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy School

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField, Required
emis_code: CharField, Required
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
village_name: CharField,
district_name: CharField,
district: CharField,
sub_county_name: ReadOnlyField,
county: ReadOnlyField,
county_name: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
emis_code: CharField,
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

/api/v1/schools/stats/<type>

GET POST OPTIONS

List Create Schools Stats

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = id, county, sub-county

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
sub_county	Sub County
name	Name
emis_code	Emis Code
phone	Phone
email	Email
school_ministry	School Ministry
founder_name	Founder Name
year_of_foundation	Year Of Foundation
ownership	Ownership
lat	Lat
lng	Lng
start_of_calendar	Start Of Calendar
end_of_calendar	End Of Calendar
active	Active
lowest_grade	Lowest Grade
highest_grade	Highest Grade
schooling	Schooling
gender	Gender
moe_id	Moe Id
moe_emis_code	Moe Emis Code
is_training_school	Is Training School
county	County

Request Fields:

{

name: CharField, Required
emis_code: CharField, Required
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
village_name: CharField,
district_name: CharField,
district: CharField,
sub_county_name: ReadOnlyField,
county: ReadOnlyField,
county_name: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
emis_code: CharField,
phone: CharField,
email: EmailField,
school_ministry: CharField,
founder_name: CharField,
year_of_foundation: DateField,
ownership: CharField,

location: ChoiceField,

Choices

Value	Meaning
R	Rural
U	Urban

lat: FloatField,
lng: FloatField,
start_of_calendar: DateField,
end_of_calendar: DateField,
active: BooleanField,

lowest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

highest_grade: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8

schooling: ChoiceField,

Choices

Value	Meaning
D	Day Only
B	Boarding Only
BD	Boarding and Day

gender: ChoiceField,

Choices

Value	Meaning
M	Boys
F	Girls
MX	Mixed

moe_id: CharField,
moe_emis_code: CharField,
is_training_school: BooleanField,
sub_county: PrimaryKeyRelatedField Help Text

}

/api/v1/schools/import/

POST OPTIONS

Import School Data

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

statistics

/api/v1/statistics/

GET OPTIONS

List All Statistics

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

regions

/api/v1/regions/

GET POST OPTIONS

List Create Regions

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
created	Created
modified	Modified
name	Name

Request Fields:

{

name: CharField Required

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField

}

/api/v1/regions/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Region

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField Required

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField

}

/api/v1/regions/<pk>/districts/

GET OPTIONS

List Region Districts

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
region	Region
name	Name

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
region: PrimaryKeyRelatedField Help Text

}

support-questions

/api/v1/support-questions/

GET POST OPTIONS

List Create Support Questions

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
title	Title
description	Description

Request Fields:

{

title: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField

}

/api/v1/support-questions/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Support Question

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

title: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
title: CharField,
description: CharField

}

districts

/api/v1/districts/

GET POST OPTIONS

List Create Districts

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
region	Region
name	Name

Request Fields:

{

name: CharField, Required
region: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
region: PrimaryKeyRelatedField Help Text

}

/api/v1/districts/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy District

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField, Required
region: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
region: PrimaryKeyRelatedField Help Text

}

/api/v1/districts/<pk>/villages/

GET OPTIONS

List District Villages

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
district	District
name	Name
lat	Lat
lng	Lng

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
district_name: CharField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
lat: FloatField,
lng: FloatField,
district: PrimaryKeyRelatedField Help Text

}

villages

/api/v1/villages/

GET POST OPTIONS

List Create Villages

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
district	District
name	Name
lat	Lat
lng	Lng

Request Fields:

{

name: CharField, Required
lat: FloatField,
lng: FloatField,
district: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
district_name: CharField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
lat: FloatField,
lng: FloatField,
district: PrimaryKeyRelatedField Help Text

}

/api/v1/villages/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Village

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField, Required
lat: FloatField,
lng: FloatField,
district: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
district_name: CharField,
region_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
lat: FloatField,
lng: FloatField,
district: PrimaryKeyRelatedField Help Text

}

stats

/api/v1/stats/

GET OPTIONS

Trigger Export

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

test-reports

/api/v1/stats/test-reports/

POST OPTIONS

Test Pdf Export

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField, Required

type: ChoiceField

Choices

Value	Meaning
pdf	PDF
png	PNG
html	HTML

}

Response Fields:

{

name: CharField,

type: ChoiceField

Choices

Value	Meaning
pdf	PDF
png	PNG
html	HTML

}

teachers

/api/v1/teachers/

GET POST OPTIONS

List Create Teachers

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = id, sub-county, county

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
first_name	First Name
middle_name	Middle Name
last_name	Last Name
user	User
date_started_teaching	Date Started Teaching
joined_current_school	Joined Current School
is_non_delete	Is Non Delete
active	Active
type	Type
tsc_no	Tsc No
phone	Phone
school	School
streams	Streams
qualifications	Qualifications
is_school_admin	Is School Admin
email	Email
marital_status	Marital Status
dob	Dob
moe_id	Moe Id
school_emis_code	School Emis Code
name	Name

Request Fields:

{

first_name: CharField, Required
middle_name: CharField,
last_name: CharField, Required
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField, Required

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Required Help Text
streams: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
username: CharField,
gender_name: CharField,
gender: CharField,
role: CharField,
role_name: CharField,
created: DateTimeField,
modified: DateTimeField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField,

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Help Text
streams: ManyRelatedField Help Text

}

/api/v1/teachers/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Teacher

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsNonDeleteTeacher	A base class from which all permission classes should inherit.

Request Fields:

{

first_name: CharField, Required
middle_name: CharField,
last_name: CharField, Required
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField, Required

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Required Help Text
streams: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
username: CharField,
gender_name: CharField,
gender: CharField,
role: CharField,
role_name: CharField,
created: DateTimeField,
modified: DateTimeField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField,

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Help Text
streams: ManyRelatedField Help Text

}

/api/v1/teachers/stats/<type>

GET POST OPTIONS

List Create Teachers Stats

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = id, sub-county, county

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
first_name	First Name
middle_name	Middle Name
last_name	Last Name
user	User
date_started_teaching	Date Started Teaching
joined_current_school	Joined Current School
is_non_delete	Is Non Delete
active	Active
type	Type
tsc_no	Tsc No
phone	Phone
school	School
streams	Streams
qualifications	Qualifications
is_school_admin	Is School Admin
email	Email
marital_status	Marital Status
dob	Dob
moe_id	Moe Id
school_emis_code	School Emis Code
name	Name

Request Fields:

{

first_name: CharField, Required
middle_name: CharField,
last_name: CharField, Required
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField, Required

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Required Help Text
streams: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
username: CharField,
gender_name: CharField,
gender: CharField,
role: CharField,
role_name: CharField,
created: DateTimeField,
modified: DateTimeField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_started_teaching: DateField,
joined_current_school: DateField,
is_non_delete: BooleanField,
active: BooleanField,

type: ChoiceField,

Choices

Value	Meaning
TSC	TSC
BRD	BOARD

tsc_no: CharField,
phone: CharField,

qualifications: ChoiceField,

Choices

Value	Meaning
NS	Not Set
UNI	UNIVERSITY
COL	COLLEGE

is_school_admin: BooleanField,
email: EmailField,

marital_status: ChoiceField,

Choices

Value	Meaning
NS	Not Set
S	Single
M	Married
D	Divorced

dob: DateField,
moe_id: CharField,
user: PrimaryKeyRelatedField, Help Text
school: PrimaryKeyRelatedField, Help Text
streams: ManyRelatedField Help Text

}

streams

/api/v1/streams/

GET POST OPTIONS

List Create Streams

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
school	School
name	Name
last_attendance	Last Attendance
base_class	Base Class
moe_id	Moe Id
moe_section_id	Moe Section Id
moe_name	Moe Name
moe_section_name	Moe Section Name
school_name	School Name
school_emis_code	School Emis Code

Request Fields:

{

name: CharField,
last_attendance: DateField,

base_class: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
10	10
11	11
12	12

moe_id: CharField,
moe_section_id: CharField,
moe_name: CharField,
moe_section_name: CharField,
school: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
class_name: ReadOnlyField,
full_class_name: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
last_attendance: DateField,

base_class: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
10	10
11	11
12	12

moe_id: CharField,
moe_section_id: CharField,
moe_name: CharField,
moe_section_name: CharField,
school: PrimaryKeyRelatedField Help Text

}

/api/v1/streams/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Stream

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.
IsAnEmptySteam	A base class from which all permission classes should inherit.

Request Fields:

{

name: CharField,
last_attendance: DateField,

base_class: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
10	10
11	11
12	12

moe_id: CharField,
moe_section_id: CharField,
moe_name: CharField,
moe_section_name: CharField,
school: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
class_name: ReadOnlyField,
full_class_name: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
last_attendance: DateField,

base_class: ChoiceField,

Choices

Value	Meaning
1	1
2	2
3	3
4	4
5	5
6	6
7	7
8	8
9	9
10	10
11	11
12	12

moe_id: CharField,
moe_section_id: CharField,
moe_name: CharField,
moe_section_name: CharField,
school: PrimaryKeyRelatedField Help Text

}

students

/api/v1/students/

GET POST OPTIONS

List Create Students

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
emis_code	Emis Code
first_name	First Name
middle_name	Middle Name
last_name	Last Name
date_of_birth	Date Of Birth
date_enrolled	Date Enrolled
admission_no	Admission No
stream	Stream
gender	Gender
previous_class	Previous Class
mode_of_transport	Mode Of Transport
time_to_school	Time To School
distance_from_school	Distance From School
household	Household
meals_per_day	Meals Per Day
not_in_school_before	Not In School Before
emis_code_histories	Emis Code Histories
total_attendance	Total Attendance
total_absents	Total Absents
last_attendance	Last Attendance
knows_dob	Knows Dob
guardian_name	Guardian Name
guardian_phone	Guardian Phone
guardian_status	Guardian Status
guardian_sub_county	Guardian Sub County
guardian_email	Guardian Email
sub_county	Sub County
village	Village
cash_transfer_beneficiary	Cash Transfer Beneficiary
active	Active
graduated	Graduated
dropout_reason	Dropout Reason
offline_id	Offline Id
status	Status
special_needs	Special Needs
graduates_class	Graduates Class
moe_id	Moe Id
moe_unique_id	Moe Unique Id
upi	Upi
base_class	Base Class
school	School
school_sub_county	School Sub County
county	County
school_county	School County
school_emis_code	School Emis Code
start_date	Start Date
end_date	End Date
year	Year
name	Name
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/dropouts/

GET OPTIONS

List Dropout Students

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
created	Created
modified	Modified
student	Student
reason	Reason
description	Description
school_id	School Id
base_class	Base Class
recorded_date	Recorded Date
start_recorded_date	Start Recorded Date
end_recorded_date	End Recorded Date
stream_id	Stream Id
sub_county_id	Sub County Id
county_id	County Id

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
dropout_reason: CharField,
first_name: CharField,
stream_name: CharField,
base_class: CharField,
school: CharField,
school_emis_code: CharField,
school_name: CharField,
middle_name: CharField,
last_name: CharField,
admission_no: CharField,
reason_description: CharField,
created: DateTimeField,
modified: DateTimeField,
description: CharField,
student: PrimaryKeyRelatedField, Help Text
reason: PrimaryKeyRelatedField Help Text

}

/api/v1/students/bulk/

GET POST PUT PATCH DELETE OPTIONS

List Create Bulk Students

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
emis_code	Emis Code
first_name	First Name
middle_name	Middle Name
last_name	Last Name
date_of_birth	Date Of Birth
date_enrolled	Date Enrolled
admission_no	Admission No
stream	Stream
gender	Gender
previous_class	Previous Class
mode_of_transport	Mode Of Transport
time_to_school	Time To School
distance_from_school	Distance From School
household	Household
meals_per_day	Meals Per Day
not_in_school_before	Not In School Before
emis_code_histories	Emis Code Histories
total_attendance	Total Attendance
total_absents	Total Absents
last_attendance	Last Attendance
knows_dob	Knows Dob
guardian_name	Guardian Name
guardian_phone	Guardian Phone
guardian_status	Guardian Status
guardian_sub_county	Guardian Sub County
guardian_email	Guardian Email
sub_county	Sub County
village	Village
cash_transfer_beneficiary	Cash Transfer Beneficiary
active	Active
graduated	Graduated
dropout_reason	Dropout Reason
offline_id	Offline Id
status	Status
special_needs	Special Needs
graduates_class	Graduates Class
moe_id	Moe Id
moe_unique_id	Moe Unique Id
upi	Upi

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/absents/

GET OPTIONS

List Absent Students

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
id	Id
student	Student
date	Date
status	Status
cause_of_absence	Cause Of Absence
stream	Stream
base_class	Base Class
start_date	Start Date
end_date	End Date
gender	Gender
learner_status	Learner Status
school	School
school_emis_code	School Emis Code
school_sub_county	School Sub County
school_county	School County
year	Year
month	Month
special_needs	Special Needs
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
reason_absent: SerializerMethodField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Student

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/stats/<type>

GET POST OPTIONS

List Dynamic Students Statistics

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = class, stream, school, sub-county, partner, county, duplicate, special-need, gender, age, id, student-status, dropout-reason, knows-dob, month, year, day, week

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
emis_code	Emis Code
first_name	First Name
middle_name	Middle Name
last_name	Last Name
date_of_birth	Date Of Birth
date_enrolled	Date Enrolled
admission_no	Admission No
stream	Stream
gender	Gender
previous_class	Previous Class
mode_of_transport	Mode Of Transport
time_to_school	Time To School
distance_from_school	Distance From School
household	Household
meals_per_day	Meals Per Day
not_in_school_before	Not In School Before
emis_code_histories	Emis Code Histories
total_attendance	Total Attendance
total_absents	Total Absents
last_attendance	Last Attendance
knows_dob	Knows Dob
guardian_name	Guardian Name
guardian_phone	Guardian Phone
guardian_status	Guardian Status
guardian_sub_county	Guardian Sub County
guardian_email	Guardian Email
sub_county	Sub County
village	Village
cash_transfer_beneficiary	Cash Transfer Beneficiary
active	Active
graduated	Graduated
dropout_reason	Dropout Reason
offline_id	Offline Id
status	Status
special_needs	Special Needs
graduates_class	Graduates Class
moe_id	Moe Id
moe_unique_id	Moe Unique Id
upi	Upi
base_class	Base Class
school	School
school_sub_county	School Sub County
county	County
school_county	School County
school_emis_code	School Emis Code
start_date	Start Date
end_date	End Date
year	Year
name	Name
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/stats/

GET POST OPTIONS

List Dynamic Students Stats Stats

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
emis_code	Emis Code
first_name	First Name
middle_name	Middle Name
last_name	Last Name
date_of_birth	Date Of Birth
date_enrolled	Date Enrolled
admission_no	Admission No
stream	Stream
gender	Gender
previous_class	Previous Class
mode_of_transport	Mode Of Transport
time_to_school	Time To School
distance_from_school	Distance From School
household	Household
meals_per_day	Meals Per Day
not_in_school_before	Not In School Before
emis_code_histories	Emis Code Histories
total_attendance	Total Attendance
total_absents	Total Absents
last_attendance	Last Attendance
knows_dob	Knows Dob
guardian_name	Guardian Name
guardian_phone	Guardian Phone
guardian_status	Guardian Status
guardian_sub_county	Guardian Sub County
guardian_email	Guardian Email
sub_county	Sub County
village	Village
cash_transfer_beneficiary	Cash Transfer Beneficiary
active	Active
graduated	Graduated
dropout_reason	Dropout Reason
offline_id	Offline Id
status	Status
special_needs	Special Needs
graduates_class	Graduates Class
moe_id	Moe Id
moe_unique_id	Moe Unique Id
upi	Upi
base_class	Base Class
school	School
school_sub_county	School Sub County
county	County
school_county	School County
school_emis_code	School Emis Code
start_date	Start Date
end_date	End Date
year	Year
name	Name
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

/api/v1/students/enrolls/<type>

GET POST OPTIONS

List Students Enrollments

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = class, stream, school, sub-county, partner, county, duplicate, special-need, gender, age, id, student-status, dropout-reason, knows-dob, month, year, day, week

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
emis_code	Emis Code
first_name	First Name
middle_name	Middle Name
last_name	Last Name
date_of_birth	Date Of Birth
date_enrolled	Date Enrolled
admission_no	Admission No
stream	Stream
gender	Gender
previous_class	Previous Class
mode_of_transport	Mode Of Transport
time_to_school	Time To School
distance_from_school	Distance From School
household	Household
meals_per_day	Meals Per Day
not_in_school_before	Not In School Before
emis_code_histories	Emis Code Histories
total_attendance	Total Attendance
total_absents	Total Absents
last_attendance	Last Attendance
knows_dob	Knows Dob
guardian_name	Guardian Name
guardian_phone	Guardian Phone
guardian_status	Guardian Status
guardian_sub_county	Guardian Sub County
guardian_email	Guardian Email
sub_county	Sub County
village	Village
cash_transfer_beneficiary	Cash Transfer Beneficiary
active	Active
graduated	Graduated
dropout_reason	Dropout Reason
offline_id	Offline Id
status	Status
special_needs	Special Needs
graduates_class	Graduates Class
moe_id	Moe Id
moe_unique_id	Moe Unique Id
upi	Upi
base_class	Base Class
school	School
school_sub_county	School Sub County
county	County
school_county	School County
school_emis_code	School Emis Code
start_date	Start Date
end_date	End Date
year	Year
name	Name
is_training_school	Is Training School
partner	Partner
no_special_needs	No Special Needs

Request Fields:

{

date_enrolled: DateField,
emis_code: IntegerField,
first_name: CharField, Required
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
stream_name: CharField,
base_class: CharField,
full_name: ReadOnlyField,
student_id: ReadOnlyField,
date_enrolled: DateField,
special_needs_details: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- abbreviation: CharField
}
county: ReadOnlyField,
guardian_county: ReadOnlyField,
age: ReadOnlyField,
status_display: ReadOnlyField,
gender_display: ReadOnlyField,
county_name: ReadOnlyField,
sub_county_name: ReadOnlyField,
guardian_county_name: ReadOnlyField,
guardian_sub_county_name: ReadOnlyField,
guardian_status_display: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
emis_code: IntegerField,
first_name: CharField,
middle_name: CharField,
last_name: CharField,
date_of_birth: DateField,
admission_no: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	MALE
F	FEMALE

previous_class: IntegerField,

mode_of_transport: ChoiceField,

Choices

Value	Meaning
PERSONAL	Personal Vehicle
BUS	School Bus
FOOT	By Foot
NS	Not Set

time_to_school: ChoiceField,

Choices

Value	Meaning
1HR	One Hour
-0.5HR	Less than 1/2 Hour
+1HR	More than one hour.
NS	Not Set

distance_from_school: IntegerField,
household: IntegerField,
meals_per_day: IntegerField,
not_in_school_before: BooleanField,
emis_code_histories: CharField,
total_attendance: IntegerField,
total_absents: IntegerField,
last_attendance: DateField,
knows_dob: BooleanField,
guardian_name: CharField,
guardian_phone: CharField,

guardian_status: ChoiceField,

Choices

Value	Meaning
B	Both Parents
S	Single Parent
N	None
NS	Not Set

guardian_email: EmailField,
village: CharField,
cash_transfer_beneficiary: BooleanField,
active: BooleanField,
graduated: BooleanField,
dropout_reason: CharField,
offline_id: CharField,

status: ChoiceField,

Choices

Value	Meaning
OOSC	Dropped Out
NE	Never Been to School
PE	Already Enrolled

moe_id: CharField,
moe_unique_id: CharField,
moe_extra_info: JSONField,
upi: CharField, Help Text
stream: PrimaryKeyRelatedField, Help Text
guardian_sub_county: PrimaryKeyRelatedField, Help Text
sub_county: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField, Help Text
special_needs: ManyRelatedField Help Text

}

promotions

/api/v1/promotions/

GET POST OPTIONS

List Create Promotions

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Param name	Description
created	Created
modified	Modified
school	School
completed	Completed
year	Year
graduates_class	Graduates Class

Request Fields:

{

stream_promotions: ListSerializer, Required
Item structure
{
- completed: BooleanField,
- prev_class: PrimaryKeyRelatedField, Required Help Text
- next_class: PrimaryKeyRelatedField, Required Help Text
- promote_school: PrimaryKeyRelatedField Help Text
}
completed: BooleanField,
year: IntegerField, Required
school: PrimaryKeyRelatedField, Required Help Text

}

Response Fields:

{

id: IntegerField,
stream_promotions: ListSerializer,
Item structure
{
- id: IntegerField,
- next_class_name: CharField,
- created: DateTimeField,
- modified: DateTimeField,
- completed: BooleanField,
- prev_class: PrimaryKeyRelatedField, Help Text
- next_class: PrimaryKeyRelatedField, Help Text
- promote_school: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
completed: BooleanField,
year: IntegerField,
school: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField Help Text

}

/api/v1/promotions/<pk>/complete/

POST OPTIONS

Retrieve Complete Undo Promotion

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

action: CharField Required

}

Response Fields:

{

action: CharField

}

/api/v1/promotions/<pk>/

GET PUT PATCH OPTIONS

Retrieve Update Destory Promotion

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

stream_promotions: ListSerializer, Required
Item structure
{
- completed: BooleanField,
- prev_class: PrimaryKeyRelatedField, Required Help Text
- next_class: PrimaryKeyRelatedField, Required Help Text
- promote_school: PrimaryKeyRelatedField Help Text
}
completed: BooleanField,
year: IntegerField, Required
school: PrimaryKeyRelatedField, Required Help Text

}

Response Fields:

{

id: IntegerField,
stream_promotions: ListSerializer,
Item structure
{
- id: IntegerField,
- next_class_name: CharField,
- created: DateTimeField,
- modified: DateTimeField,
- completed: BooleanField,
- prev_class: PrimaryKeyRelatedField, Help Text
- next_class: PrimaryKeyRelatedField, Help Text
- promote_school: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
completed: BooleanField,
year: IntegerField,
school: PrimaryKeyRelatedField, Help Text
graduates_class: PrimaryKeyRelatedField Help Text

}

downloads

/api/v1/downloads/

GET OPTIONS

List Create Exports

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
custom_report_name	Custom Report Name
title	Title
description	Description
status	Status
rows_count	Rows Count
exported_rows_count	Exported Rows Count
args	Args
type	Type
start_time	Start Time
end_time	End Time
user	User
errors	Errors
is_custom	Is Custom
start_date	Start Date
end_date	End Date
list_size	List Size

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
status_display: CharField,
completed_percentage: ReadOnlyField,
rows_count: MyCustomSerializerField,
exported_rows_count: MyCustomSerializerField,
duration: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

/api/v1/downloads/custom/

GET POST OPTIONS

List Create Custom Exports

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
custom_report_name	Custom Report Name
title	Title
description	Description
status	Status
rows_count	Rows Count
exported_rows_count	Exported Rows Count
args	Args
type	Type
start_time	Start Time
end_time	End Time
user	User
errors	Errors
is_custom	Is Custom
start_date	Start Date
end_date	End Date
list_size	List Size

Request Fields:

{

name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
status_display: CharField,
completed_percentage: ReadOnlyField,
duration: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

rows_count: IntegerField,
exported_rows_count: IntegerField,
args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

/api/v1/downloads/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Export

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

rows_count: MyCustomSerializerField, Required
exported_rows_count: MyCustomSerializerField, Required
name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
status_display: CharField,
completed_percentage: ReadOnlyField,
rows_count: MyCustomSerializerField,
exported_rows_count: MyCustomSerializerField,
duration: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
custom_report_name: CharField,
title: CharField,
description: CharField,

status: ChoiceField,

Choices

Value	Meaning
Q	Queued
E	Exporting...
P	Preparing Download...
F	Failed
D	Click To Download

args: CharField,

type: ChoiceField,

Choices

Value	Meaning
C	CSV
P	PDF

file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
errors: CharField,
is_custom: BooleanField,
start_date: DateField,
end_date: DateField,

list_size: ChoiceField,

Choices

Value	Meaning
20	20
50	50
100	100
300	300
500	500
800	800
1000	1000
10000	10000

user: PrimaryKeyRelatedField Help Text

}

students-delete-reasons

/api/v1/students-delete-reasons/

GET POST OPTIONS

List Create Delete Reasons

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
description	Description

Request Fields:

{

name: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
description: CharField

}

/api/v1/students-delete-reasons/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Delete Reason

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
description: CharField

}

/api/v1/students-delete-reasons/stats/<type>/

GET OPTIONS

List Dynamic Student Delete Reasonss Statistics

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = id, class, gender, reason, reason-description

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
student	Student
reason	Reason
description	Description
school_id	School Id
base_class	Base Class
recorded_date	Recorded Date
start_recorded_date	Start Recorded Date
end_recorded_date	End Recorded Date
stream_id	Stream Id
sub_county_id	Sub County Id
county_id	County Id

Request Fields:

No input data specified

Response Fields:

{

id: IntegerField,
dropout_reason: CharField,
first_name: CharField,
stream_name: CharField,
base_class: CharField,
school: CharField,
school_emis_code: CharField,
school_name: CharField,
middle_name: CharField,
last_name: CharField,
admission_no: CharField,
reason_description: CharField,
created: DateTimeField,
modified: DateTimeField,
description: CharField,
student: PrimaryKeyRelatedField, Help Text
reason: PrimaryKeyRelatedField Help Text

}

students-absent-reasons

/api/v1/students-absent-reasons/

GET POST OPTIONS

List Create Absent Reasons

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
description	Description

Request Fields:

{

name: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
description: CharField

}

/api/v1/students-absent-reasons/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Absent Reason

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

{

name: CharField, Required
description: CharField

}

Response Fields:

{

id: IntegerField,
school_name: CharField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
description: CharField

}

/api/v1/students-absent-reasons/stats/<type>/

GET OPTIONS

List Dynamic Student Absent Reasons Statistics

Open Link

Description
Authentication
Permissions
Filters

Group statistics by:
type = id, class, gender, reason, reason-description

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
student	Student
reason	Reason
date	Date
description	Description
school_id	School Id
base_class	Base Class
recorded_date	Recorded Date
start_recorded_date	Start Recorded Date
end_recorded_date	End Recorded Date
stream_id	Stream Id
sub_county_id	Sub County Id
county_id	County Id
start_attendance_date	Start Attendance Date
end_attendance_date	End Attendance Date

Request Fields:

No input data specified

Response Fields:

No output data specified

/api/v1/ping/

GET POST OPTIONS

Ping Server

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

Request Fields:

No input data specified

Response Fields:

No output data specified

counties

/api/v1/counties/

GET POST OPTIONS

List Create Countys

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
number	Number
headquarters	Headquarters

Request Fields:

{

name: CharField, Required
number: CharField,
headquarters: CharField

}

Response Fields:

{

id: IntegerField,
sub_counties: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- partner_names: CharField,
- county: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
name: CharField,
number: CharField,
headquarters: CharField

}

/api/v1/counties/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy County

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
number: CharField,
headquarters: CharField

}

Response Fields:

{

id: IntegerField,
sub_counties: ListSerializer,
Item structure
{
- id: IntegerField,
- created: DateTimeField,
- modified: DateTimeField,
- name: CharField,
- partner_names: CharField,
- county: PrimaryKeyRelatedField Help Text
}
created: DateTimeField,
modified: DateTimeField,
name: CharField,
number: CharField,
headquarters: CharField

}

sub-counties

/api/v1/sub-counties/

GET POST OPTIONS

List Create Sub Countys

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
county	County
name	Name
partner_names	Partner Names

Request Fields:

{

name: CharField, Required
partner_names: CharField,
county: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
partner_names: CharField,
county: PrimaryKeyRelatedField Help Text

}

/api/v1/sub-counties/update-partners/

POST OPTIONS

Update Sub County Partner Names

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
county	County
name	Name
partner_names	Partner Names

Request Fields:

{

name: CharField, Required
partner_names: CharField,
county: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
partner_names: CharField,
county: PrimaryKeyRelatedField Help Text

}

/api/v1/sub-counties/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Sub County

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
partner_names: CharField,
county: PrimaryKeyRelatedField Required Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
partner_names: CharField,
county: PrimaryKeyRelatedField Help Text

}

special-needs

/api/v1/special-needs/

GET POST OPTIONS

List Create Special Needs

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
abbreviation	Abbreviation

Request Fields:

{

name: CharField, Required
abbreviation: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
abbreviation: CharField

}

/api/v1/special-needs/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Special Need

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

name: CharField, Required
abbreviation: CharField

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
name: CharField,
abbreviation: CharField

}

support-requests

/api/v1/support-requests/

GET POST OPTIONS

List Create Support Requests

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
school	School
user	User
email	Email
name	Name
subject	Subject
body	Body
phone	Phone

Request Fields:

{

email: EmailField, Required
name: CharField, Required
subject: CharField, Required
body: CharField, Required
phone: CharField, Required
school: PrimaryKeyRelatedField, Required Help Text
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: ReadOnlyField,
school_emis_code: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
email: EmailField,
name: CharField,
subject: CharField,
body: CharField,
phone: CharField,
school: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/support-requests/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Support Request

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

email: EmailField, Required
name: CharField, Required
subject: CharField, Required
body: CharField, Required
phone: CharField, Required
school: PrimaryKeyRelatedField, Required Help Text
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
school_name: ReadOnlyField,
school_emis_code: ReadOnlyField,
created: DateTimeField,
modified: DateTimeField,
email: EmailField,
name: CharField,
subject: CharField,
body: CharField,
phone: CharField,
school: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

schools-imports

/api/v1/schools-imports/

GET POST OPTIONS

List Create Schools Students Imports

Open Link

Description
Authentication
Permissions
Filters

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Param name	Description
created	Created
modified	Modified
name	Name
user	User
import_type	Import Type
step	Step
start_time	Start Time
end_time	End Time
args	Args
rows_count	Rows Count
imported_rows_count	Imported Rows Count
duplicates_count	Duplicates Count
error_rows_count	Error Rows Count
new_students_created	New Students Created
should_import	Should Import
nemis_group_id	Nemis Group Id
nemis_institution_level	Nemis Institution Level
errors	Errors
update_learner	Update Learner

Request Fields:

{

raw_data: JSONField,
name: CharField,
import_file: FileField,

import_type: ChoiceField,

Choices

Value	Meaning
F	Import File
NMC	Nemis County
NMSC	Nemis Sub County
NMSCH	Nemis School
JS	Json Data

errors_file: FileField,
should_import: BooleanField,
nemis_group_id: CharField, Help Text
nemis_institution_level: CharField, Help Text
errors: CharField,
update_learner: BooleanField,
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
step_display: ReadOnlyField,

user_details: MyUserSerializer,

Item structure

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

clean: ReadOnlyField,
is_clean: ReadOnlyField,
name: CharField,
import_file: FileField,

import_type: ChoiceField,

Choices

Value	Meaning
F	Import File
NMC	Nemis County
NMSC	Nemis Sub County
NMSCH	Nemis School
JS	Json Data

step: CharField,
errors_file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
args: CharField,
rows_count: IntegerField,
imported_rows_count: IntegerField,
duplicates_count: IntegerField,
error_rows_count: IntegerField,
new_students_created: IntegerField,
should_import: BooleanField,
nemis_group_id: CharField, Help Text
nemis_institution_level: CharField, Help Text
errors: CharField,
update_learner: BooleanField,
user: PrimaryKeyRelatedField Help Text

}

/api/v1/schools-imports/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Schools Students Import

Open Link

Description
Authentication
Permissions

No description provided by developer

Action is allowed if any of these auth types is provided(logic OR)

Type	Description
OAuth2Authentication	OAuth 2 authentication backend using `django-oauth-toolkit`
SessionAuthentication	Use Django's session framework for authentication.

Action is allowed when all of conditions are satisfied(logic AND)

Type	Description
IsAuthenticated	Allows access only to authenticated users.

Request Fields:

{

raw_data: JSONField,
name: CharField,
import_file: FileField,

import_type: ChoiceField,

Choices

Value	Meaning
F	Import File
NMC	Nemis County
NMSC	Nemis Sub County
NMSCH	Nemis School
JS	Json Data

errors_file: FileField,
should_import: BooleanField,
nemis_group_id: CharField, Help Text
nemis_institution_level: CharField, Help Text
errors: CharField,
update_learner: BooleanField,
user: PrimaryKeyRelatedField Help Text

}

Response Fields:

{

id: IntegerField,
created: DateTimeField,
modified: DateTimeField,
step_display: ReadOnlyField,

user_details: MyUserSerializer,

Item structure

{

id: IntegerField,
first_name: CharField,
full_name: ReadOnlyField,
dummy: BooleanField,
filter_args: CharField,
is_school_admin: BooleanField,
teacher: IntegerField,
school: IntegerField,
school_name: CharField,
emis_code: CharField,
role_name: CharField,
last_name: CharField,
username: CharField, Help Text
dob: DateField,
changed_password: BooleanField,

role: ChoiceField,

Choices

Value	Meaning
A	Admin
SCHA	School Admin
SCHT	School Teacher
CO	County Officer
SCO	Sub County Officer
RO	Read Only

image: Base64ImageField,
email: EmailField,
phone: CharField,

gender: ChoiceField,

Choices

Value	Meaning
M	Male
F	Female
NS	Not Set

profile_image: SerializerMethodField,
gender_display: CharField

}

clean: ReadOnlyField,
is_clean: ReadOnlyField,
name: CharField,
import_file: FileField,

import_type: ChoiceField,

Choices

Value	Meaning
F	Import File
NMC	Nemis County
NMSC	Nemis Sub County
NMSCH	Nemis School
JS	Json Data

step: CharField,
errors_file: FileField,
start_time: DateTimeField,
end_time: DateTimeField,
args: CharField,
rows_count: IntegerField,
imported_rows_count: IntegerField,
duplicates_count: IntegerField,
error_rows_count: IntegerField,
new_students_created: IntegerField,
should_import: BooleanField,
nemis_group_id: CharField, Help Text
nemis_institution_level: CharField, Help Text
errors: CharField,
update_learner: BooleanField,
user: PrimaryKeyRelatedField Help Text

}

Digital Attendance Application Kenya

https://onekana.naconek.ke/assets/images/kenya_logo.png

api

v1

users

List Create System Users

Request Fields:

Response Fields:

List Activity Logs

Request Fields:

No input data specified

Response Fields:

Export Activity Logs

Request Fields:

No input data specified

Response Fields:

Retrieve Update Client

Request Fields:

Response Fields:

Retrieve Client

Request Fields:

Response Fields:

Clients Change Password

Request Fields:

No input data specified

Response Fields:

No output data specified

Clients Resend Confirm Email

Request Fields:

No input data specified

Response Fields:

No output data specified

Clients Forgot Password

Request Fields:

Response Fields:

Clients Reset Password

Request Fields:

Response Fields:

Admin Reset Enum Password

Request Fields:

Response Fields:

User Teacher School Info

Request Fields:

No input data specified

Response Fields:

attendances

student-absent-reasons

List Create Student Absent Reasons

Request Fields:

Response Fields:

Retrieve Update Destroy Student Absent Reason

Request Fields:

Response Fields:

List Create Attendances

Request Fields:

Response Fields:

Retrieve Update Destroy Attendance

Request Fields:

Response Fields:

List Dynamic Attendances Statistics

Request Fields:

Response Fields:

List Create Attendance Statistics

Request Fields:

No input data specified

Response Fields:

schools

List Create Schools

Request Fields:

Response Fields:

Rest Report

Request Fields:

No input data specified

Response Fields:

No output data specified

Moe Test

Request Fields:

No input data specified

Response Fields:

No output data specified