Enrollments API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Enrollments

Retrieves a paginated list of all enrollments 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/enrollments/{id} 200 OK

Get Single Enrollment

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

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

Enrollment Not Found

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

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

Create Enrollment

Registers a new enrollment with the provided details. On success, returns the newly created enrollment 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
studentName string Required Student name
courseCode string Required Course code
enrolledOn datetime Required Enrolled on
status string Required Status
progressPercent integer Required Progress percent
grade string Optional Grade
Body
Response: 201 Created
PUT /api/enrollments/{id} 200 OK

Update Enrollment

Fully replaces an existing enrollment'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
studentName string Required Student name
courseCode string Required Course code
enrolledOn datetime Required Enrolled on
status string Required Status
progressPercent integer Required Progress percent
grade string Optional Grade
Body
Response: 200 OK
DELETE /api/enrollments/{id} 204 No Content

Delete Enrollment

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

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