Cancel Appointment_External

# Cancel Appointment (`mutation`) Este método permite cancelar una cita existente en el sistema identificándola a través de su `councilId`. La operación admite la posibilidad de notificar de forma automática al participante sobre la revocación de la cita mediante el parámetro `notify`, así como incluir un texto descriptivo con el motivo de la cancelación a través del campo `message`. ### Detalles de la Solicitud - **Método HTTP:** `POST` - **URL PRE:** `https://api.ovac.pre.councilbox.com/graphql` - **URL PRO:** `https://api.ovac.pre.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) | Parámetro | Descripción | Requerido | Tipo | | --- | --- | --- | --- | | **councilId** | Id de la cita que se desea cancelar. | SI | Integer | | **notify** | Campo para activar o desactivar el aviso de cancelación de la cita al participante. | SI | Boolean | | **message** | Mensaje con el motivo de cancelación de la cita. | NO | String | | **reason** | A continuación se describen los motivos de cancelación: <br>'`unavailable`' -> Participante no disponible <br>'`not_interested`' -> Participante no interesado <br>'`procedure_already_completed`' -> Procedimiento ya realizado <br>'`incorrect_data`' -> Datos incorrectos <br>'`difficult_access`' -> Dificultad en el acceso <br>'`incompatible_browser`' -> Navegador incompatible <br>'`others`' -> Otros motivos | NO | String | ### Campos de Respuesta (Payload) La operación devuelve un resultado funcional simple bajo el objeto `cancelAppointment`: | **Campo** | **Tipo** | **Descripción** | | --- | --- | --- | | **success** | Boolean | Devuelve `true` si la cancelación se procesó correctamente; `false` en caso contrario. | | **message** | String | Mensaje 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 ``` 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) ``` json { "councilId": 12345, "notify": true, "reason": "unavailable", "message": "Mensaje con el motivo de cancelación" } ``` ### 3\. Ejemplo de comando cURL ``` bash 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){ cancelAppointment(councilId: $councilId, notify:$notify, message: $message){ success message } }","variables":{"councilId":64683,"notify":true,"message":"MOTIVO CANCELACION"}}' ``` ### 4\. Respuesta Esperada (200 OK) ``` json { "data": { "cancelAppointment": { "success": true, "message": null } } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/cancelappointment-2` para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es `POST /graphql`.