Skip to navigation
Métodos API04 - Get Appointment Information

Get Appointment Evidence Summary

View as Markdown

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.

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
councilIddentificador numérico único de la cita en OVAC.SIInteger

Campos de Respuesta (Payload)

La consulta agrupa la información del encuentro en cuatro grandes bloques funcionales (act, evidences, recordings, surveys):

ParámetroDescripciónTipo
dataObjeto de DataObject
data.councilEvidenceSummaryObjeto de la evidenciaObject
data.councilEvidenceSummary.councilIdIdentificador de la citaInteger
data.councilEvidenceSummary.actObjeto del acta (informe), si no hay informe los valores estarán a _null_Object
data.councilEvidenceSummary.act.idIdentificador único del informeInteger
data.councilEvidenceSummary.act.downloadLinkEnlace de descarga, para descargarlo es necesario añadir autenticación, es decir API Key con el token adquirido en el loginString
data.councilEvidenceSummary.evidencesConjunto de evidencias de la cita. en formato JSONArray
data.councilEvidenceSummary.evidences[].dateFecha de creaciónString
data.councilEvidenceSummary.evidences[].userIdIdentificador único del usuario que crea la citaInteger
data.councilEvidenceSummary.evidences[].contentContenido en JSON sobre la cita.String
data.councilEvidenceSummary.evidences[].typeTipo de citaString
data.councilEvidenceSummary.evidences[].hashHash atribuido a la evidenciaString
data.councilEvidenceSummary.recordingsConjunto de información para la evidencia de grabaciónArray
data.councilEvidenceSummary.recordings[].sizeTamaño en bytesString
data.councilEvidenceSummary.recordings[].urlEnlace 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 loginString
data.councilEvidenceSummary.recordings[].createdAtFecha de creación de la grabaciónString
data.councilEvidenceSummary.recordings[].signatureDocumentUrlIndica si el vídeo está firmado, si es así, muestra la firmaString
data.councilEvidenceSummary.recordings[].signatureUrlEnlace para descarga del vídeo firmado.String
data.councilEvidenceSummary.recordings[].sessionIdIdentificador del vídeoString
data.councilEvidenceSummary.recordings[].ididentificador único de cita y vídeo, usado para la descarga de los vídeosString
data.councilEvidenceSummary.recordings[].durationDuración de la grabación en segundosString

Ejemplos de Código y Peticiones

1. Consulta 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)

{
    "councilId": 64687
}

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":"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)

{
  "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.