Overview

Profile Scope

Resource Summary

Doctor Resource

Patient Resource

Appointment Resource

Specialization Resource

Search

/profile/patient

/profile/doctor

/doctor

<h1>Resources Summary</h1>
<p>Overview of resources provided by the Core REST API.</p>
<h2>Doctors and Doctors Appointment Settings</h2>
<table>
<thead>
<tr>
<th>Authorized Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>Read a Doctor Profile</td>
<td>GET <code>/profile/doctor</code></td>
</tr>
<tr>
<td>Update a Doctor Profile</td>
<td>PUT <code>/profile/doctor</code></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Public Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>Read Details of a Doctor</td>
<td>GET <code>/doctors/:id</code></td>
</tr>
<tr>
<td>List (Search and Filter) Doctors</td>
<td>GET <code>/doctors</code></td>
</tr>
</tbody>
</table>
<h2>Patients</h2>
<table>
<thead>
<tr>
<th>Authorized Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>Read a Patient Profile</td>
<td>GET <code>/profile/patient</code></td>
</tr>
<tr>
<td>Update a Patient Profile</td>
<td>PUT <code>/profile/patient</code></td>
</tr>
</tbody>
</table>
<h2>Appointments</h2>
<table>
<thead>
<tr>
<th>Authorized Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>List Appointments of a Doctor</td>
<td>GET <code>/profile/doctor/appointments</code></td>
</tr>
<tr>
<td>Create an Appointment as a Doctor</td>
<td>POST <code>/profile/doctor/appointments</code></td>
</tr>
<tr>
<td>List Appointments of a Patient</td>
<td>GET <code>/profile/patient/appointments</code></td>
</tr>
<tr>
<td>Create an Appointment as a Patient</td>
<td>POST <code>/profile/patient/appointments</code></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Public Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>List Appointments of Doctors</td>
<td>GET <code>/appointments</code></td>
</tr>
</tbody>
</table>
<h2>Specializations</h2>
<table>
<thead>
<tr>
<th>Public Users</th>
<th>Endpoint</th>
</tr>
</thead>
<tbody>
<tr>
<td>List Official Specializations</td>
<td>GET <code>/specializations</code></td>
</tr>
</tbody>
</table>


Authorized Users	Endpoint
Read a Doctor Profile	GET `/profile/doctor`
Update a Doctor Profile	PUT `/profile/doctor`

Public Users	Endpoint
Read Details of a Doctor	GET `/doctors/:id`
List (Search and Filter) Doctors	GET `/doctors`

Authorized Users	Endpoint
Read a Patient Profile	GET `/profile/patient`
Update a Patient Profile	PUT `/profile/patient`

Authorized Users	Endpoint
List Appointments of a Doctor	GET `/profile/doctor/appointments`
Create an Appointment as a Doctor	POST `/profile/doctor/appointments`
List Appointments of a Patient	GET `/profile/patient/appointments`
Create an Appointment as a Patient	POST `/profile/patient/appointments`