Prescriptions API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Prescriptions

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

Get Single Prescription

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

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

Prescription Not Found

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

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

Create Prescription

Registers a new prescription with the provided details. On success, returns the newly created prescription 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
patientName string Required Patient name
doctorName string Required Doctor name
medicationName string Required Medication name
dosage string Required Dosage
frequencyPerDay integer Required Frequency per day
durationDays integer Required Duration days
notes string Optional Notes
status string Required Status
Body
Response: 201 Created
PUT /api/prescriptions/{id} 200 OK

Update Prescription

Fully replaces an existing prescription'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
patientName string Required Patient name
doctorName string Required Doctor name
medicationName string Required Medication name
dosage string Required Dosage
frequencyPerDay integer Required Frequency per day
durationDays integer Required Duration days
notes string Optional Notes
status string Required Status
Body
Response: 200 OK
DELETE /api/prescriptions/{id} 204 No Content

Delete Prescription

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

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