Scribd
Upload
10 views5 pages

API Documentation

APIs define rules and protocols for software applications to communicate and interact, abstracting away complexity. APIs allow an admin/client to add, delete, update, edit, and view student, enrollee, and subject information stored in a database by responding to selected requests.

Uploaded by

novencidojethro08
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
10 views5 pages

API Documentation

APIs define rules and protocols for software applications to communicate and interact, abstracting away complexity. APIs allow an admin/client to add, delete, update, edit, and view student, enrollee, and subject information stored in a database by responding to selected requests.

Uploaded by

novencidojethro08
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 5

What is API?

API stands for Application Programming Interface. It's a set of rules, protocols, and tools that allows different
software applications to communicate with each other. APIs define the methods and data formats that developers can
use to interact with a service or system, abstracting away the complexity of the underlying implementation.

How API works?

HIGH – LEVEL TECHNICAL DIAGRAM

First is the Admin/Client will use the API to add, delete, update, edit, and view of some information of the
Student, Enrollees and Subjects that will be stored in DataBase. The API will also respond to the selected request of the
Client/Admin.
saveStudent
responsible for handling requests to add or update student information in the system's database.

Endpoint:

Payload:

Result:
updateStudent
facilitates the modification of existing student records within the system's database.
Endpoint:

Payload:

Result:
deleteStudent
facilitates the removal of student records from the system's database.
Endpoint:

Payload:

Result:
enrollStudent
manages the enrollment process for students in courses or programs offered by
the institution.
Endpoint:

Payload:

Result:

You might also like