Get Appointment Evidence Summary

View as Markdown
# Get Appointment Evidence Summary (`query`) Este método permite recuperar de forma centralizada toda la pista de auditoría, metadatos de control, encuestas, grabaciones multimedia y el acta/informe digital oficial asociados a una cita completada o programada dentro de la plataforma OVAC. ### 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 | dentificador numérico único de la cita en OVAC. | SI | Integer | ### Campos de Respuesta (Payload) La consulta agrupa la información del encuentro en cuatro grandes bloques funcionales (`act`, `evidences`, `recordings`, `surveys`): | `Parámetro` | `Descripción` | `Tipo` | | --- | --- | --- | | data | Objeto de Data | Object | | data.councilEvidenceSummary | Objeto de la evidencia | Object | | data.councilEvidenceSummary.councilId | Identificador de la cita | Integer | | data.councilEvidenceSummary.act | Objeto del acta (informe), si no hay informe los valores estarán a `_null_` | Object | | data.councilEvidenceSummary.act.id | Identificador único del informe | Integer | | data.councilEvidenceSummary.act.downloadLink | Enlace de descarga, para descargarlo es necesario añadir autenticación, es decir API Key con el token adquirido en el login | String | | data.councilEvidenceSummary.evidences | Conjunto de evidencias de la cita. en formato JSON | Array | | data.councilEvidenceSummary.evidences\[\].date | Fecha de creación | String | | data.councilEvidenceSummary.evidences\[\].userId | Identificador único del usuario que crea la cita | Integer | | data.councilEvidenceSummary.evidences\[\].content | Contenido en JSON sobre la cita. | String | | data.councilEvidenceSummary.evidences\[\].type | Tipo de cita | String | | data.councilEvidenceSummary.evidences\[\].hash | Hash atribuido a la evidencia | String | | data.councilEvidenceSummary.recordings | Conjunto de información para la evidencia de grabación | Array | | data.councilEvidenceSummary.recordings\[\].size | Tamaño en bytes | String | | data.councilEvidenceSummary.recordings\[\].url | Enlace de descarga del vídeo de la cita, se mostrarán tantos enlaces como vídeos exista, para descargar es necesario usar autenticación API Key con el token generado en el login | String | | data.councilEvidenceSummary.recordings\[\].createdAt | Fecha de creación de la grabación | String | | data.councilEvidenceSummary.recordings\[\].signatureDocumentUrl | Indica si el vídeo está firmado, si es así, muestra la firma | String | | data.councilEvidenceSummary.recordings\[\].signatureUrl | Enlace para descarga del vídeo firmado. | String | | data.councilEvidenceSummary.recordings\[\].sessionId | Identificador del vídeo | String | | data.councilEvidenceSummary.recordings\[\].id | identificador único de cita y vídeo, usado para la descarga de los vídeos | String | | data.councilEvidenceSummary.recordings\[\].duration | Duración de la grabación en segundos | String | ## Ejemplos de Código y Peticiones ### 1\. Consulta GraphQL ``` graphql query CouncilEvidenceSummary($councilId: Int, $externalId: String) { councilEvidenceSummary(councilId: $councilId, externalId: $externalId) { councilId act { id downloadLink } evidences { date userId content type hash } recordings { size url createdAt signatureDocumentUrl signatureUrl sessionId id duration } surveys { id councilId creationDate participantId data participant { id email surname dni name councilId externalId } } } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "councilId": 64687 } ``` ### 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":"query CouncilEvidenceSummary($councilId: Int, $externalId: String){ councilEvidenceSummary(councilId: $councilId, externalId: $externalId){ councilId act { id downloadLink } evidences { date userId content type hash } recordings { size url createdAt signatureDocumentUrl signatureUrl sessionId id duration } surveys { id councilId creationDate participantId data participant { id email surname dni name councilId externalId } } } }","variables":{"councilId":64687}}' ``` ### 4\. Respuesta Esperada (200 OK) ``` json { "data": { "councilEvidenceSummary": { "councilId": 64687, "act": { "id": 7571, "downloadLink": "https://api.ovac.pre.councilbox.com/council/64687/act" }, "evidences": [ { "date": "2026-04-17T07:53:05.685Z", "userId": 3477, "content": "{\"data\":{\"council\":{\"company\":{\"address\":\"TEST API\",\"businessName\":\"TEST API\",\"id\":2191},\"dateStart\":\"2026-04-17T08:00:40.436Z\",\"id\":64687,\"name\":\"TEST\"}}}", "type": "CONVENE_COUNCIL_WITH_NOTICE", "hash": "4557033a-0318-441c-9615-d2c24e1c020c" }, { "date": "2026-04-17T08:33:37.442Z", "userId": 3477, "content": "{\"data\":{\"council\":{\"id\":64687,\"name\":\"TEST\",\"dateStartRecording\":\"2026-04-17T08:33:37.441Z\"}}}", "type": "START_RECORDING", "hash": "80bb946e-0f3f-4c07-b66e-8eca096f79aa" } ], "recordings": [ { "size": "20905", "url": "https://api.ovac.pre.councilbox.com/api/recording/64687-69e1f050c246e6ee55055021", "createdAt": "1776414811764", "signatureDocumentUrl": null, "signatureUrl": null, "sessionId": "69e1f050c246e6ee55055021", "id": "64687-69e1f050c246e6ee55055021", "duration": "2.036" } ], "surveys": [] } } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/councilevidencesummary` 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.