Company Procedures | Councilbox OVAC API

# Company Statutes (`query`) 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. ### 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 | | --- | --- | --- | --- | | companyId | Identificador único de la entidad en OVAC donde se busca la disponibilidad. | SI | Integer | | councilType | Filtro por tipo de canal. Admite los siguientes valores: <br>`null` -> Muestra todos los trámites (por defecto). <br>`5` -> Videoatención. <br>`6` -> Gestión desatendida. <br>`7` -> Presencial. | NO | Integer | ### Campos de Respuesta (Payload) La consulta devuelve una colección directa de objetos bajo el campo raíz `companyStatutes`: | Parámetro | Descripción | Tipo | | --- | --- | --- | | companyStatutes | Array con el listado de trámites vinculados que cumplen los filtros. | Array | | companyStatutes.**id** | Identificador interno único del trámite en la plataforma OVAC. | Integer | | companyStatutes.**externalId** | Código o identificador del trámite en el sistema del cliente de origen. | String | | companyStatutes.**title** | Nombre o denominación oficial del trámite (ej. "TEST"). | String | | companyStatutes.**councilType** | Código numérico que representa el canal de atención asignado a ese trámite. | Integer | ## Ejemplos de Código y Peticiones ### 1\. Consulta GraphQL ``` graphql query Statutes($companyId: Int!, $councilType: Int) { companyStatutes(companyId: $companyId, councilType: $councilType) { id externalId title councilType } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "companyId": 2191, "councilType": null } ``` ### 3\. Ejemplo de comando cURL ``` bash 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) ``` json { "data": { "companyStatutes": [ { "id": 4685, "externalId": null, "title": "TEST", "councilType": 5 } ] } } ``` > **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`.

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.

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
companyId	Identificador único de la entidad en OVAC donde se busca la disponibilidad.	SI	Integer
councilType	Filtro 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.	NO	Integer

Campos de Respuesta (Payload)

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

Parámetro	Descripción	Tipo
companyStatutes	Array con el listado de trámites vinculados que cumplen los filtros.	Array
companyStatutes.id	Identificador interno único del trámite en la plataforma OVAC.	Integer
companyStatutes.externalId	Código o identificador del trámite en el sistema del cliente de origen.	String
companyStatutes.title	Nombre o denominación oficial del trámite (ej. “TEST”).	String
companyStatutes.councilType	Código numérico que representa el canal de atención asignado a ese trámite.	Integer

Ejemplos de Código y Peticiones

1. Consulta GraphQL

1 query Statutes($companyId: Int!, $councilType: Int) {
2     companyStatutes(companyId: $companyId, councilType: $councilType) {
3         id
4         externalId
5         title
6         councilType
7     }
8 }

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

1 {
2     "companyId": 2191,
3     "councilType": null
4 }

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)

1 {
2     "data": {
3         "companyStatutes": [
4             {
5                 "id": 4685,
6                 "externalId": null,
7                 "title": "TEST",
8                 "councilType": 5
9             }
10         ]
11     }
12 }

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.