Skip to navigation

Add Step to Appointment

View as Markdown

Esta operación permite añadir dinámicamente un nuevo paso durante la ejecución de la cita/gestión, por ejemplo, un consentimiento explícito. De forma automática, en vivo, se añadirá un nuevo paso en la plataforma como complemento a la cita/gestión.

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
agendaObjeto contenedor principal con las propiedades técnicas del punto a insertar.SIObject
agenda.councilIdIdentificador numérico único de la cita existente a la cual se asociará el punto.SIInteger
agenda.subjectTypeCódigo numérico que define el comportamiento del punto en la interfaz:
9 -> Consentimiento explícito .
SI
agenda.agendaSubjectEnunciado, título literal o descripción pública de la votación o consentimiento legal.NOString

Campos de respuesta (Payload)

La mutación devuelve un objeto estructurado bajo el campo raíz addAgendaPoint:

ParámetroDescripciónTipo
addAgendaPointObjeto con el resultado del punto del orden del día registrado.Object
addAgendaPoint.idIdentificador único generado para el nuevo punto del orden del día insertadoInteger

Ejemplos de código y peticiones

1. Consulta GraphQL

mutation AddAgendaPoint (
$agenda: AgendaInput
){
addAgendaPoint(
agenda: $agenda
) {
id
}
}

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

{
"agenda": {
"councilId": 65167,
"subjectType": 9,
"agendaSubject": "TEST API"
}
}

3. Ejemplo de comando cURL

curl --location 'https://api.ovac.pre.councilbox.com/graphql' \
--header 'Content-Type: application/json' \
--header 'x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNmQxOTY3ZS04MDY3LTRiMDUtYjQ0MS0zZmFhYWVlN2M3ZDUiLCJ1c2VyX2lkIjozND76LCJ0b2tlbl90eXBlIjoidXNlciIsImlhdCI6MTc4MTA3NjAyMH0.aXYLM7tX0xYjzi4m7gGNUlZ4Dj15cG-iIakmzGwhDTs' \
--data '{"query":"mutation AddAgendaPoint ($agenda: AgendaInput){ addAgendaPoint(agenda: $agenda) { id } }","variables":{"agenda":{"councilId":65167,"subjectType":9,"agendaSubject":"TEST API"}}}'

4. Respuesta Esperada (200 OK)

{
"data": {
"addAgendaPoint": {
"id": 91051
}
}
}

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