Doctors API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Doctors

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

Get Single Doctor

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

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

Doctor Not Found

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

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

Create Doctor

Registers a new doctor with the provided details. On success, returns the newly created doctor 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
specialty string Required Specialty
licenseNumber string Required License number
email string Required Email
phone string Required Phone
hospital string Required Hospital
yearsOfExperience integer Required Years of experience
consultationFee decimal Required Consultation fee
Body
Response: 201 Created
PUT /api/doctors/{id} 200 OK

Update Doctor

Fully replaces an existing doctor'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
specialty string Required Specialty
licenseNumber string Required License number
email string Required Email
phone string Required Phone
hospital string Required Hospital
yearsOfExperience integer Required Years of experience
consultationFee decimal Required Consultation fee
Body
Response: 200 OK
DELETE /api/doctors/{id} 204 No Content

Delete Doctor

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

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