Recurso

Notificaciones

10 operaciones · base https://api.bestdoctorsrd.com

PATCH/v1/appointments/{appointment_id}/status

Update appointment status

When an appointment is confirmed, notifies the assigned user for that patient.

Parámetros

NombreEnTipoObl.
appointment_idpathstring

Cuerpo obligatorio AppointmentStatusUpdateIn

CampoTipoObl.
statusAppointmentStatus

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaStatusOut
422Error de validaciónHTTPValidationError
PATCH/v1/lab-orders/{order_id}/status

Update lab order status

When a lab order is completed, notifies the user assigned to the ordering doctor.

Parámetros

NombreEnTipoObl.
order_idpathstring

Cuerpo obligatorio LabOrderStatusUpdateIn

CampoTipoObl.
statusLabOrderStatus
notestring o nuloNo
reportTextstring o nuloNo
artifactUrlstring o nuloNo
artifactContentTypestring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaStatusOut
422Error de validaciónHTTPValidationError
GET/v1/notification-rules

List notification routing rules

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de NotificationRuleOut
422Error de validaciónHTTPValidationError
POST/v1/notification-rules

Configure a notification routing and escalation rule

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Cuerpo obligatorio NotificationRuleIn

CampoTipoObl.
eventTypestring
targetRolestring
prioritystringNo
escalationDelayMinutesintegerNo
escalationTargetRolestring o nuloNo
isActivebooleanNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaNotificationRuleOut
422Error de validaciónHTTPValidationError
GET/v1/notifications

List notifications for the authenticated user

Returns only notifications addressed to the current authenticated user.

Parámetros

NombreEnTipoObl.
unreadqueryboolean o nuloNo
acknowledgedqueryboolean o nuloNo
escalatedqueryboolean o nuloNo
limitqueryinteger o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaNotificationListOut
422Error de validaciónHTTPValidationError
POST/v1/notifications/escalate-due

Escalate high-priority unacknowledged notifications due by rule delay

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaEscalationRunOut
422Error de validaciónHTTPValidationError
GET/v1/notifications/operations-console

Summarize notification escalation and integration monitoring

Parámetros

NombreEnTipoObl.
tenantIdquerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaNotificationOperationsConsoleOut
422Error de validaciónHTTPValidationError
PATCH/v1/notifications/read-all

Mark all notifications as read

Sets isRead=true and readAt=now for every unread notification owned by the authenticated user.

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaReadAllOut
PATCH/v1/notifications/{notification_id}/acknowledge

Acknowledge a notification

Marks a notification as operationally acknowledged without changing read state.

Parámetros

NombreEnTipoObl.
notification_idpathstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaNotificationOut
422Error de validaciónHTTPValidationError
PATCH/v1/notifications/{notification_id}/read

Mark a notification as read

Marks a single notification owned by the authenticated user as read.

Parámetros

NombreEnTipoObl.
notification_idpathstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaNotificationOut
422Error de validaciónHTTPValidationError