10 operaciones · base https://api.bestdoctorsrd.com
/v1/appointments| Nombre | En | Tipo | Obl. |
|---|---|---|---|
doctorId | query | string o nulo | No |
patientId | query | string o nulo | No |
fromDate | query | string (date-time) o nulo | No |
toDate | query | string (date-time) o nulo | No |
status | query | string o nulo | No |
mode | query | string o nulo | No |
tenant_id | query | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | lista de AppointmentOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments| Nombre | En | Tipo | Obl. |
|---|---|---|---|
tenant_id | query | string o nulo | No |
AppointmentCreateIn| Campo | Tipo | Obl. |
|---|---|---|
patientId | string | Sí |
doctorId | string | Sí |
departmentId | string o nulo | No |
scheduledAt | string (date-time) | Sí |
reason | string | Sí |
mode | string | No |
branchId | string o nulo | No |
locationId | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 201 | Respuesta correcta | AppointmentOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments/operations| Nombre | En | Tipo | Obl. |
|---|---|---|---|
doctorId | query | string o nulo | No |
patientId | query | string o nulo | No |
fromDate | query | string (date-time) o nulo | No |
toDate | query | string (date-time) o nulo | No |
status | query | string o nulo | No |
mode | query | string o nulo | No |
search | query | string o nulo | No |
page | query | integer | No |
pageSize | query | integer | No |
tenant_id | query | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | AppointmentOperationsPageOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments/{appointment_id}| Nombre | En | Tipo | Obl. |
|---|---|---|---|
appointment_id | path | string | Sí |
tenant_id | query | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | AppointmentOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments/{appointment_id}| Nombre | En | Tipo | Obl. |
|---|---|---|---|
appointment_id | path | string | Sí |
tenant_id | query | string o nulo | No |
AppointmentUpdateIn| Campo | Tipo | Obl. |
|---|---|---|
patientId | string o nulo | No |
doctorId | string o nulo | No |
departmentId | string o nulo | No |
scheduledAt | string (date-time) o nulo | No |
reason | string o nulo | No |
mode | string o nulo | No |
branchId | string o nulo | No |
status | string o nulo | No |
cancelReason | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | AppointmentOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments/{appointment_id}/action| Nombre | En | Tipo | Obl. |
|---|---|---|---|
appointment_id | path | string | Sí |
tenant_id | query | string o nulo | No |
AppointmentOperationActionIn| Campo | Tipo | Obl. |
|---|---|---|
action | string | Sí |
scheduledAt | string (date-time) o nulo | No |
cancelReason | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | AppointmentOut |
| 422 | Error de validación | HTTPValidationError |
/v1/appointments/{appointment_id}/closure-gatesQué le falta a esta consulta para poder cerrarse. Va declarada ANTES que `/v1/appointments/{appointment_id}`: al revés, «closure-gates» entraría por el parámetro de ruta y esto devolvería un 404 de cita inexistente. Existe para que la pantalla pueda decir qué falta en vez de dejar que el usuario se estrelle contra un 409 sin explicación. Es informativa: quien manda es el guardián del cierre, no esto.
| Nombre | En | Tipo | Obl. |
|---|---|---|---|
appointment_id | path | string | Sí |
tenant_id | query | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | objeto |
| 422 | Error de validación | HTTPValidationError |
/v1/doctors/{doctor_id}/available-slots| Nombre | En | Tipo | Obl. |
|---|---|---|---|
doctor_id | path | string | Sí |
date | query | string (date) | Sí |
tenant_id | query | string o nulo | No |
locationId | query | string o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | lista de AvailableSlotOut |
| 422 | Error de validación | HTTPValidationError |
/v1/public/appointments/requestsCreates a public appointment request tied to a provider and optionally to a specific slot.
AppointmentRequestCreate| Campo | Tipo | Obl. |
|---|---|---|
provider_id | integer | Sí |
slot_id | integer o nulo | No |
patient_name | string | Sí |
patient_email | string (email) o nulo | No |
patient_phone | string o nulo | No |
reason | string | Sí |
| Código | Descripción | Devuelve |
|---|---|---|
| 201 | Respuesta correcta | AppointmentRequestOut |
| 422 | Error de validación | HTTPValidationError |
/v1/public/appointments/slotsReturns unbooked appointment slots for public scheduling by provider.
| Nombre | En | Tipo | Obl. |
|---|---|---|---|
provider_idProvider identifier | query | integer | Sí |
from_dateOptional lower bound for slot start time | query | string (date-time) o nulo | No |
| Código | Descripción | Devuelve |
|---|---|---|
| 200 | Respuesta correcta | lista de AppointmentSlotOut |
| 422 | Error de validación | HTTPValidationError |