Patients API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Patients

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

Get Single Patient

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

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

Patient Not Found

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

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

Create Patient

Registers a new patient with the provided details. On success, returns the newly created patient 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
patientCode string Required Patient code
dateOfBirth datetime Required Date of birth
gender string Required Gender
bloodType string Required Blood type
email string Required Email
phone string Required Phone
city string Required City
isInsured boolean Required Is insured
Body
Response: 201 Created
PUT /api/patients/{id} 200 OK

Update Patient

Fully replaces an existing patient'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
patientCode string Required Patient code
dateOfBirth datetime Required Date of birth
gender string Required Gender
bloodType string Required Blood type
email string Required Email
phone string Required Phone
city string Required City
isInsured boolean Required Is insured
Body
Response: 200 OK
DELETE /api/patients/{id} 204 No Content

Delete Patient

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

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