Skip to navigation

Get Company Procedures

View as Markdown

Esta operación permite consultar el catálogo de trámites configurados y vinculados a una entidad determinada. Ofrece un parámetro de filtrado opcional para segmentar de forma directa los resultados según el canal o tipo de atención requerido.

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
companyIdIdentificador único de la entidad en OVAC donde se busca la disponibilidad.SIInteger
councilTypeFiltro por tipo de canal. Admite los siguientes valores:
null -> Muestra todos los trámites (por defecto).
5 -> Videoatención.
6 -> Gestión desatendida.
7 -> Presencial.
NOInteger

Campos de Respuesta (Payload)

La consulta devuelve una colección directa de objetos bajo el campo raíz companyStatutes:

ParámetroDescripciónTipo
companyStatutesArray con el listado de trámites vinculados que cumplen los filtros.Array
companyStatutes.idIdentificador interno único del trámite en la plataforma OVAC.Integer
companyStatutes.externalIdCódigo o identificador del trámite en el sistema del cliente de origen.String
companyStatutes.titleNombre o denominación oficial del trámite (ej. “TEST”).String
companyStatutes.councilTypeCódigo numérico que representa el canal de atención asignado a ese trámite.Integer
companyStatutes.notificationTypeMétodo de notificación por defecto:
0 -> email
1 -> SMS
2 -> WhatsApp
Integer
companyStatutes.notificationsAvailableMétodos de envío de notificación permitidos, es un array separado por comas: “0,1,2”, en el ejemplo indica que todos están permitidos.Array

Ejemplos de Código y Peticiones

1. Consulta GraphQL

query Statutes($companyId: Int!, $councilType: Int) {
companyStatutes(companyId: $companyId, councilType: $councilType) {
id
externalId
title
councilType
notificationType
notificationsAvailable
}
}

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

{
"companyId": 2191,
"councilType": null
}

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 statutes($companyId: Int!, $councilType: Int) { companyStatutes(companyId: $companyId, councilType: $councilType) { id externalId title councilType } }","variables":{"companyId":2191,"councilType":null}}'

4. Respuesta Esperada (200 OK)

{
"data": {
"companyStatutes": [
{
"id": 4685,
"externalId": null,
"title": "TEST",
"councilType": 5
"notificationType": 0,
"notificationsAvailable": "0,1,2"
}
]
}
}

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