Get Appointment Information_External

Este método permite obtener información detallada y estructurada de una cita a partir de sus identificadores externos corporativos (councilExternalId y companyExternalId). Devuelve el estado actual de la convocatoria, el canal de atención, las marcas de tiempo de control, los datos del agente asignado, los datos de los ciudadanos participantes, el trámite asociado y el desglose de las fases de la agenda junto con las evidencias digitales recolectadas.

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)

Campos de Respuesta (Payload)

La consulta agrupa la información del encuentro bajo el nodo raíz council con la siguiente taxonomía:

1. Datos Generales de la Cita (council)

2. Desglose de Objetos y Arrays Anidados

Objeto assignedUser (Agente Asignado)

Perfil del profesional responsable de atender o gestionar la cita.

• id (Int): Identificador único interno del agente en OVAC.

• name / surname (String): Nombre y apellidos del profesional.

• email (String): Correo electrónico corporativo del operario.

• externalId (String): ID único del agente en el sistema externo del cliente.

Array participants (Ciudadanos Convocados)

Listado de los ciudadanos registrados en la cita (asistentes principales, representantes o invitados).

• name / surname (String): Nombre y apellidos del participante. (Nota: Corregido de Integer a String).

• email (String): Dirección de correo donde el ciudadano recibe las alertas y enlaces.

• dni (String): Documento identificativo o código fiscal.

• idCardType (String): Tipo de identificación ("dni", "nif", "nie", "passport", "codiceFiscale", "europeanDocument").

• idCardCountry (String): Código del país emisor de la documentación (ISO 3166-1 alfa-2).

• zipcode (String): Código postal registrado.

Objeto statute (Trámite Asociado)

Información sobre el tipo de trámite o procedimiento administrativo que se ejecuta en la cita.

• id (Int): ID de la instancia de asignación del trámite.

• title (String): Nombre oficial del trámite (ej. "TEST").

• statuteId (Int): Identificador maestro del procedimiento dentro de la plataforma.

Array agendas (Puntos de Control y Flujo de Trabajo)

Listado secuencial con las tareas, hitos y recolección de evidencias configuradas para el trámite.

• id (Int): Identificador único del punto o paso de la agenda.

• name (String): Nombre descriptivo de la acción (ej. "Escaneo de documentación", "Firma de documentación").

• attachments (Array): Documentos aportados al punto por el profesional de la entidad. Contiene el objeto user (operador que lo subió), filename, downloadUrl y el filesize en bytes. Si fue subido de manera autónoma por el ciudadano, este objeto se devuelve vacío.

• participants (Array): Colección con las interacciones multimedia y firmas ejecutadas por el ciudadano en este paso:

  • type (String): Tipo de acción interactiva ejecutada (SIGNATURE [Firma electrónica], BIOMETRIC [Validación biométrica], INTERACTIVE_DOCS [Formularios PDF interactivos], SCREEN_CAPTURE [Escáner o captura de documentación]).

  • agendaSignatoriesParticipantsAttachments (Array): Listado que aloja las evidencias binarias finales resultantes de la acción del ciudadano (ej. el DNI digitalizado o el contrato firmado), detallando su id, filename y la url segura de acceso al archivo.

Ejemplos de Código y Peticiones

1. Consulta GraphQL

query CouncilInfo($councilExternalId: String!, $companyExternalId: String!) {
    council(externalId: $councilExternalId, companyExternalId: $companyExternalId) {
        state
        councilType
        dateStart
        dateRealStart
        dateEnd
        adminUrl
        noCelebrateComment
        observations
        internalNotes
        comment
        assignedUser {
            id
            name
            surname
            email
            externalId
        }
        participants {
            name
            surname
            email
            dni
            idCardType
            idCardCountry
            zipcode
        }
        statute {
            id
            title
            statuteId
        }
        agendas {
            id
            name
            attachments {
                user {
                    id
                    name
                    surname
                }
                filename
                downloadUrl
                filesize
            }
            participants {
                type
                agendaSignatoriesParticipantsAttachments {
                    id
                    filename
                    url
                }
            }
        }
    }
}

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

{
    "councilExternalId": "Council_ID_EXT_9982",
    "companyExternalId": "API_TEST"
}

3. Ejemplo de comando cURL

curl --location --globoff 'https://api.ovac.pre.councilbox.com/graphql' \
--header 'Content-Type: application/json' \
--header 'x-jwt-token: {{token}}' \
--data '{"query":"query CouncilInfo($councilExternalId: String!, $companyExternalId: String!){ council(externalId: $councilExternalId, companyExternalId: $companyExternalId){ state councilType dateStart dateRealStart dateEnd adminUrl noCelebrateComment observations internalNotes comment assignedUser { id name surname email externalId } participants { name surname email dni idCardType idCardCountry zipcode } statute { id title statuteId } agendas { id name attachments { user { id name surname } filename downloadUrl filesize } participants { type agendaSignatoriesParticipantsAttachments { id filename url } } } } }","variables":{"councilExternalId":"Council_ID_EXT_9982","companyExternalId":"API_TEST"}}'

4. Respuesta Esperada (200 OK)

{
    "data": {
        "council": {
            "state": 60,
            "councilType": 5,
            "dateStart": "2026-04-21T08:00:47.339Z",
            "dateRealStart": "2026-04-21T07:31:23.016Z",
            "dateEnd": "2026-04-21T07:58:12.113Z",
            "adminUrl": "https://apitest.ovac.pre.councilbox.com/company/2191/council/64706/",
            "noCelebrateComment": "",
            "observations": "Observaciones de la cita",
            "internalNotes": "Notas internas del trámite",
            "comment": null,
            "assignedUser": {
                "id": 3477,
                "name": "API",
                "surname": "PROFESIONAL",
                "email": "alejandro.maneiro+apiprof@councilbox.com",
                "externalId": null
            },
            "participants": [
                {
                    "name": "SOY EL PARTICIPANTE",
                    "surname": "TEST",
                    "email": "alejandro.maneiro+participante@councilbox.com",
                    "dni": "77777777B",
                    "idCardType": "dni",
                    "idCardCountry": "ES"
                }
            ],
            "statute": {
                "id": 64888,
                "title": "TEST",
                "statuteId": 4685
            },
            "agendas": [
                {
                    "id": 88520,
                    "name": "Escaneo de documentación",
                    "attachments": [],
                    "participants": [
                        {
                            "type": "SCREEN_CAPTURE",
                            "agendaSignatoriesParticipantsAttachments": [
                                {
                                    "id": 2664,
                                    "filename": "Documento_identificativo.png",
                                    "url": "https://api.ovac.pre.councilbox.com/file/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTA0ODksImlhdCI6MTc3Njc1ODM0N30.NpfjhF50QayagYCgE59xbnIau5sOxTKsXtL_HRYOJOs"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": 88519,
                    "name": "PDF Interactivo",
                    "attachments": [
                        {
                            "user": {
                                "id": 3477,
                                "name": "API",
                                "surname": "PROFESIONAL"
                            },
                            "filename": "formulario_interactivo.pdf",
                            "downloadUrl": "https://api.ovac.pre.councilbox.com/agendaAttachment/42106",
                            "filesize": "3885"
                        }
                    ],
                    "participants": [
                        {
                            "type": "INTERACTIVE_DOCS",
                            "agendaSignatoriesParticipantsAttachments": [
                                {
                                    "id": 2667,
                                    "filename": "formulario_interactivo.pdf",
                                    "url": "https://api.ovac.pre.councilbox.com/file/eyJhbGciOiJIUzI1NiIsInR5cCI6... "
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

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