Saltar al contenido principal

Reprogramar una cita

POST/appointments/{appointmentId}/reschedule

Cambia atomicamente una cita a la opcion indicada: reserva la nueva capacidad y libera la anterior solo si toda la operacion confirma. Exige option token nuevo y version vigente.

curl --request POST \
  --url '${BASE_URL}/appointments/60000000-0000-4000-8000-000000000001/reschedule' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'Content-Type: application/json' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000011' \
  --header 'Idempotency-Key: reschedule-demo-0001' \
  --data '{
    "optionToken": "opt_preview_synthetic_new_option",
    "expectedVersion": 1
  }'

Request

Headers y parametros

NombreUbicacionRequeridoDescripcion
appointmentIdpathSiIdentificador opaco de la cita dentro del tenant autenticado.
X-Correlation-IdheaderNoUUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite.
Idempotency-KeyheaderSiClave unica por service principal y operacion; reutilizarla con otro payload produce 409.

Payload

Nueva opcion opaca y version de la cita a reemplazar.

Content-Type: application/json

CampoTipoRequeridoDescripcion
expectedVersionintegerSi-
optionTokenstringSi-

Ejemplo

ejemplo del payload
{
  "expectedVersion": 1,
  "optionToken": "opt_preview_synthetic_new_option"
}

Responses

200Cita reprogramada o replay valido.

Content-Type: application/json

CampoTipoRequeridoDescripcion
endsAtstring (date-time)Si-
idstring (uuid)Si-
patientIdstring (uuid)Si-
serviceIdstring (uuid)Si-
startsAtstring (date-time)Si-
statusstringSiPENDING, CONFIRMED, CHECKED_IN, ATTENDED, CANCELLED, NO_SHOW
versionintegerSi-

Ejemplo

ejemplo de respuesta 200
{
  "endsAt": "2026-08-03T09:30:00-05:00",
  "id": "60000000-0000-4000-8000-000000000001",
  "patientId": "20000000-0000-4000-8000-000000000001",
  "serviceId": "30000000-0000-4000-8000-000000000003",
  "startsAt": "2026-08-03T09:00:00-05:00",
  "status": "PENDING",
  "version": 1
}
400Solicitud mal formada o parametro invalido.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 400
{
  "code": "INVALID_REQUEST",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "detail": "Revise los parametros enviados.",
  "status": 400,
  "title": "Solicitud invalida",
  "type": "https://magnosoft.com.co/problems/invalid-request"
}
401Token ausente, invalido, vencido o con audience incorrecta.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 401
{
  "code": "INVALID_ACCESS_TOKEN",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 401,
  "title": "Autenticacion requerida",
  "type": "https://magnosoft.com.co/problems/unauthorized"
}
403Service principal autenticado sin el scope requerido.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 403
{
  "code": "INSUFFICIENT_SCOPE",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 403,
  "title": "Permiso insuficiente",
  "type": "https://magnosoft.com.co/problems/forbidden"
}
404Recurso inexistente o no visible dentro del tenant autenticado.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 404
{
  "code": "RESOURCE_NOT_FOUND",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 404,
  "title": "Recurso no encontrado",
  "type": "https://magnosoft.com.co/problems/not-found"
}
409Conflicto de concurrencia, capacidad o reutilizacion de idempotencia.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 409
{
  "code": "CONCURRENT_MODIFICATION",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "detail": "El recurso cambio; consulte su estado antes de reintentar.",
  "status": 409,
  "title": "Conflicto de estado",
  "type": "https://magnosoft.com.co/problems/conflict"
}
410Option token vencido o recurso temporal que ya no puede consumirse.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 410
{
  "code": "OPTION_EXPIRED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 410,
  "title": "Opcion vencida",
  "type": "https://magnosoft.com.co/problems/option-expired"
}
422JSON valido que incumple una regla de validacion del contrato.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 422
{
  "code": "VALIDATION_FAILED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "errors": [
    {
      "code": "INVALID_DATE",
      "field": "serviceDate",
      "message": "Debe ser una fecha ISO 8601 valida."
    }
  ],
  "status": 422,
  "title": "Validacion fallida",
  "type": "https://magnosoft.com.co/problems/validation"
}
429Limite de solicitudes excedido para el service principal.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 429
{
  "code": "RATE_LIMIT_EXCEEDED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 429,
  "title": "Demasiadas solicitudes",
  "type": "https://magnosoft.com.co/problems/rate-limit"
}