Skip to navigation

Cancel Appointment

View as Markdown

Este método permite cancelar una cita existente en el sistema identificándola a través de su councilId. Opcionalmente, permite notificar al participante e incluir un mensaje con el motivo de la cancelación.

Detalles de la Solicitud

  • Método HTTP: POST

  • URL PRE: https://api.ovac.pre.councilbox.com/graphql

  • URL PRO: https://api.ovac.councilbox.com/graphql

Autenticación

Tipo: API Key**
Header:** x-jwt-token
Ubicación: Header HTTP_
Ejemplo:_ x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6...

Referencia de la API

Parámetros de Entrada (Variables)

CampoTipoRequeridoDescripción
councilIdIntegerSíIdentificador único de la cita que se desea cancelar.
notifyBooleanSíIndica si se debe enviar una notificación automática de cancelación al participante (true/false).
messageStringNoTexto informativo o descripción con el motivo del desestimiento.
reasonStringNoA continuación se describen los motivos de cancelación:
‘unavailable’ -> Participante no disponible
‘not_interested’ -> Participante no interesado
‘procedure_already_completed’ -> Procedimiento ya realizado
‘incorrect_data’ -> Datos incorrectos
‘difficult_access’ -> Dificultad en el acceso
‘incompatible_browser’ -> Navegador incompatible
‘others’ -> Otros motivos

Campos de Respuesta (Payload)

Al ejecutar la mutación, el sistema devolverá un objeto cancelAppointment con los siguientes campos funcionales:

CampoTipoDescripción
successBooleanDevuelve true si la cancelación se procesó correctamente; false en caso contrario.
messageStringMensaje informativo del sistema o detalle del error. Puede devolver null si la operación es limpia.

Ejemplos de Código y Peticiones

1. Mutación GraphQL

mutation CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String) {
cancelAppointment(councilId: $councilId, notify: $notify, message: $message) {
success
message
}
}

2. Variables de la Petición (JSON Payload)

{
"councilId": 64683,
"notify": true,
"reason": "unavailable",
"message": "MOTIVO CANCELACION"
}

3. Ejemplo de comando cURL

curl --location 'https://api.ovac.pre.councilbox.com/graphql' \
--header 'Content-Type: application/json' \
--header 'x-jwt-token: {{token}}' \
--data '{"query":"mutation CancelAppointment($councilId: Int!, $notify: Boolean!, $message: String){\n cancelAppointment(councilId: $councilId, notify:$notify, message: $message){\n success\n message\n }\n}\n","variables":{"councilId":64683,"notify":true,"message":"MOTIVO CANCELACION"}}'

4. Respuesta Esperada (200 OK)

{
"data": {
"cancelAppointment": {
"success": true,
"message": null
}
}
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/cancelappointment para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es POST /graphql.

Authentication

x-jwt-tokenstring
JWT token obtained from Login.

Request

This endpoint expects an object.
querystringRequired
GraphQL operation
variablesobjectOptional
GraphQL variables

Response

Successful response. GraphQL business errors may be returned inside the JSON errors field while transport status remains HTTP 200.