Get available appointment agendas

View as Markdown
# Get available appointment agendas (`query`) Esta operación permite obtener el desglose estructurado de todos los pasos (`agendas`) vinculados a una cita o gestión específica. Es el método idóneo para recuperar de forma masiva la configuración interactiva de una sesión junto con el histórico completo de respuestas (`votings`) recopiladas. ### 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 | Identificador numérico único de la cita o gestión que se desea consultar. | SI | Int | ### Campos de respuesta (Payload) La consulta devuelve un árbol jerárquico bajo el campo raíz de datos `council`: | Parámetro | Descripción | Tipo | | --- | --- | --- | | council | Objeto contenedor con las propiedades de la cita localizada. | Object | | council.**agendas\[\]** | Array o lista que recopila cada uno de los pasos configurados para la cita/gestión. | Array | | council.agendas\[\].**id** | Identificador interno único del paso. | Integer | | council.agendas\[\].**name** | Descripción pública del paso dentro de la cita/gestión (ej. "TEST API"). | String | | council.agendas\[\].**votings\[\]** | Colección de registros con las interacciones y respuestas emitidas por los participantes. | Array | | council.agendas\[\].votings\[\].**id** | Identificador único del registro de la interacción. | Integer | | council.agendas\[\].votings\[\].**vote** | Código numérico que representa el sentido o estado de la respuesta. <br>Para los pasos de tipo consentimiento de aceptación/rechazo: <br>`-1` -> Sin respuesta <br>`0` -> Rechazado <br>`1` -> Aceptado | Integer | ## Ejemplos de código y peticiones ### 1\. Consulta GraphQL ``` graphql query Council($councilId: Int!){ council(id: $councilId){ agendas { id name votings { id vote } } } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "councilId": 65181 } ``` ### 3\. Ejemplo de comando cURL ``` bash curl --location 'https://api.ovac.pre.councilbox.com/graphql' \ --header 'Content-Type: application/json' \ --header 'x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNmQxOTY3ZS04MDY3LTRiMDUtYjQ0MS0zZmFhYWVlN2M3ZDUiLCJ1c2VyX2lkIjozNDc2LCJ0b2tlbl90eXBlIjoidXNlciIsImlhdCI6MTc4MTA3NjAyMH0.aXYLM7tX0xYjzi4m7gGNUlZ4Dj15cG-iIakmzGwhDTs' \ --data '{"query":"query Council($councilId: Int!){ council(id: $councilId){ agendas { id name votings { id vote } } } }","variables":{"councilId":65167}}' ``` ### 4\. Respuesta esperada (200 OK) ``` json { "data": { "council": { "agendas": [ { "id": 91079, "name": "La dirección proporcionada es Calle Nueva, número 7 en Teo, A Coruña CP 15883", "votings": [ { "id": 40291, "vote": -1 } ] }, { "id": 91080, "name": "Nueva dirección", "votings": [ { "id": 40292, "vote": 0 } ] }, { "id": 91081, "name": "", "votings": [ { "id": 40293, "vote": 1 } ] } ] } } } ``` > **Nota OpenAPI/Fern:** esta operación GraphQL se documenta como `/graphql/council` 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.