Students API

v1.0 • REST • JSON

Full CRUD management for student accounts. Create, retrieve, update, and delete student records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/students

Quick Reference

GET
/api/students List all students (paginated)
200 GET
/api/students/{id} Get one student by ID
200 POST
/api/students Create a new student
201 PUT
/api/students/{id} Replace student data
204 DEL
/api/students/{id} Remove a student
204 GET
/api/students/{id} Student not found example
404
GET /api/students 200 OK

Get All Students

Retrieves a paginated list of all students in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/students/{id} 200 OK

Get Single Student

Fetch the full profile for a specific student using their numeric ID. Returns all student fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique student identifier
Response: 200 OK
GET /api/students/{id} 404 Not Found

Student Not Found

Returned when the requested student ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing student resources.

Response: 404 Not Found
POST /api/students 201 Created

Create Student

Registers a new student with the provided details. On success, returns the newly created student object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
studentNumber string Required Student number
email string Required Email
major string Required Major
yearLevel integer Required Year level
dateOfBirth datetime Required Date of birth
isActive boolean Required Is active
Body
Response: 201 Created
PUT /api/students/{id} 200 OK

Update Student

Fully replaces an existing student's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
studentNumber string Required Student number
email string Required Email
major string Required Major
yearLevel integer Required Year level
dateOfBirth datetime Required Date of birth
isActive boolean Required Is active
Body
Response: 200 OK
DELETE /api/students/{id} 204 No Content

Delete Student

Permanently removes a student from the system by their ID. This action is irreversible once deleted, the student record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the student to delete
Response: 204 No Content