Skip to navigation

Close Appointment

View as Markdown

Esta operación permite finalizar una cita o gestión. Al ejecutar esta mutación, el sistema bloquea cualquier interacción posterior, actualiza el estado del encuentro al ciclo de cierre y consolida de forma definitiva el rastro de auditoría junto con las anotaciones administrativas aportadas por el agente o el sistema de origen.

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)

ParámetroDescripciónRequeridoTipo
councilIdIdentificador numérico único de la cita o gestión que se desea consultar.SIInt
internalNotesTexto libre para incorporar notas internas sobre la resolución de la cita/gestión.NOString

Campos de respuesta (Payload)

La mutación devuelve un objeto de confirmación bajo el campo raíz endCouncil:

ParámetroDescripciónTipo
endCouncilObjeto contenedor con el resultado de la solicitud de finalización.Object
endCouncil.successBandera booleana que confirma si el proceso de cierre de la cita fue satisfactorio (truefalse).

Ejemplos de código y peticiones

1. Consulta GraphQL

mutation endCouncil (
$councilId: Int!
$internalNotes: String
){
endCouncil(
councilId: $councilId
internalNotes: $internalNotes
) {
success
}
}

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

{
"councilId": 65164,
"internalNotes": "Se finaliza la gestión de forma correcta"
}

3. Ejemplo de comando cURL

curl --location 'https://api.ovac.pre.councilbox.com/graphql' \
--header 'Content-Type: application/json' \
--header 'x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNmQxOTY3ZS04MDY3LTRiMDUtYjQ0MS0zZmFhYWVlN2M3ZDUiLCJ1c2VyX2lkIjozNDc2LCJ0b2tlbl90eXBlIjoidXNlciIsImlhdCI6MTt4MTA3NjAyMH0.aXYLM7tX0xYjzi4m7gGNUlZ4Dj15cG-iIakmzGwhDTs' \
--data '{"query":"mutation endCouncil ($councilId: Int!, $internalNotes: String){ endCouncil(councilId: $councilId, internalNotes: $internalNotes) { success } }","variables":{"councilId":65164,"internalNotes":"Se finaliza la gestión de forma correcta"}}'

4. Respuesta esperada (200 OK)

{
"data": {
"endCouncil": {
"success": true
}
}
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/endcouncil 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.