Appointments API

v1.0 • REST • JSON

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

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

Quick Reference

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

Get All Appointments

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

Get Single Appointment

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

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

Appointment Not Found

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

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

Create Appointment

Registers a new appointment with the provided details. On success, returns the newly created appointment 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
appointmentDate datetime Required Appointment date
reason string Required Reason
status string Required Status
roomNumber string Required Room number
consultationType string Required Consultation type
Body
Response: 201 Created
PUT /api/appointments/{id} 200 OK

Update Appointment

Fully replaces an existing appointment'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
appointmentDate datetime Required Appointment date
reason string Required Reason
status string Required Status
roomNumber string Required Room number
consultationType string Required Consultation type
Body
Response: 200 OK
DELETE /api/appointments/{id} 204 No Content

Delete Appointment

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

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